Rename project to funkwhale/ui

Thanks a lot for reporting your experience with Funkwhale! 🐳 A member of the team will have a look at this ticket as soon as possible. Afterwards this ticket will follow our issue workflow. We would really appreciate if you could check back to answer questions. Enjoy!

/cc @funkwhale/steering

added StatusNeeds triage label

I'd like to discuss this first.

We do have a pretty weird situation now. At the beginning we wanted to have funkwhale/ui and funkwhale/vui. Now we have everything in one package and we probably should rename this to funkwhale/ui. I think its better to have the name include a reference to funkwhale, so its clear its our internal toolkit, which might be used by others as well, but it should be somehow related to Funkwhale.

@wvffle What do you think?

When I've first heard of vui, I wasn't sure what is it and couldn't find it on the internet. After everything cleared out, I was surprised, that we have a name for the components library. I wasn't sure why do we have the name but started to implement the components with the fw- prefix, just as they've been implemented previously in the scss files.

But then my thought process was like so: Since we have a dedicated name for the library, we should probably call the components the same. Sure, the class names might stay the same but since the library is in very early stage of development and isn't being used anywhere (besides my university projects) or at least we're not informed of that, it wouldn't hurt much and would make the library more user friendly in the future.

But.

If our plans are to use it only internally, we could stick with fw- prefixes, vui name and funkwhale/ui repo. However I think that this might be confusing later. On the other hand we could call it something like funkwhale-components with funkwhale/components repo name and fw- prefix which would resolve the potential communication problems enhancing developer experience. I also think that funkwhale/components would be more appropriate name for an internal components library.

Note that in the proposed case, there wouldn't be any temptation to change the global .funkwhale to anything else. If we stayed with the name vui and this issue would be resolved, we might want to change the class to .vui somewhere in the future creating a need to update our blog and god knows what else

I think something like components is misleading if you want to import the static css we build. funkwhale-ui with the repository located at funkwhale/ui and using the prefix fw- is probably the best we can get.

Vui was mostly a working title for the work in progress thing, I don't think there is a point keeping the name, even though we would need to change something at the website and the blog (but thats minor)

In order to align things, its probably good to change the global .funkwhale to .fw so its aligned to the component names?

I still opt for the funkwhale/components name as we're technically using the static stylesheets for the components. Resigning from the vui name in favor of funkwhale/ui and referring to it as our UI library does not seem like a bad choice either. I'd say the choice is yours, I like both options.

I wanted to propose the change to .fw as it's just much quicker to type :P

I think the usage of funkwhale/ui is better then, because https://ui.funkwhale.audio as website for the projects fits into the scheme.

I'll execute the non-code tasks required to get there and hit you up when I'm done

I moved the project, the docs and artifacts already are deployed to https://ui.funkwhale.audio anyways and I adjusted the Pipeline configs to make sure everything still works.