search

overhangio / tutor-mfe

This plugin makes it possible to easily add micro frontend (MFE) applications on top of an Open edX platform that runs with Tutor.
GNU Affero General Public License v3.0
22 stars 91 forks source link

Rename `course-authoring` -> `authoring`? #224

Open kdmccormick opened 2 weeks ago

kdmccormick commented 2 weeks ago

frontend-app-course-authoring was renamed to frontend-app-authoring: https://github.com/openedx/frontend-app-authoring/pull/1289

At a minimum, we should update the URLs here.

Should we rename the app as well? It would be a breaking change for plugin authors.

If so, can we add a /course-authoring/* -> /authoring/* redirect to caddy to avoid breaking links?

regisb commented 2 weeks ago

Yes, that makes sense, but can I suggest a different url? /authoring is not a very conventional path. It's very "English". Should we redirect to /studio or /cms instead?

I don't have a very strong opinion on this, it's mostly a gut feeling. What do you think?

kdmccormick commented 2 weeks ago

As a dev, it's nice that the URL names map exactly to the repo names, so /authoring is my top choice (too bad you didn't suggest frontend-app-studio for the name up the upstream repo :)

As someone who speaks only American English, /authoring and /studio both sound equally good to me. But I take your word that the latter may sound better to a global audience, so I am totally fine if you'd like to go with that.

My only strong opinion is that I don't like /cms. If you don't know what CMS stands for, it's meaningless. Even if you do know what CMS stands for, then you'd probably think about Wordpress or Drupal before you think of something like Studio. The only reason we still call it CMS at all is because it's baked into so many parts of the codebase.

regisb commented 2 weeks ago

I'm definitely over-thinking this, thanks for indulging me. Let's go with /authoring.