Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename course-authoring -> authoring? #224

Closed
kdmccormick opened this issue Sep 16, 2024 · 4 comments · Fixed by #225
Closed

Rename course-authoring -> authoring? #224

kdmccormick opened this issue Sep 16, 2024 · 4 comments · Fixed by #225

Comments

@kdmccormick
Copy link
Contributor

frontend-app-course-authoring was renamed to frontend-app-authoring: openedx/frontend-app-authoring#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?
@kdmccormick kdmccormick mentioned this issue Sep 16, 2024
Closed
@regisb
Copy link
Contributor

regisb commented Sep 19, 2024

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
Copy link
Contributor Author

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
Copy link
Contributor

regisb commented Sep 20, 2024

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

regisb added a commit that referenced this issue Sep 20, 2024
@regisb
feat: rename "course-authoring" MFE to "authoring"
0184779 
Existing URLs are (301, permanently) redirected to the new ones. We are
doing this because the course-authoring MFE has been migrated to a new
repository.

Close #224.
@regisb regisb mentioned this issue Sep 20, 2024
Merged
regisb added a commit that referenced this issue Sep 20, 2024
@regisb
feat: rename "course-authoring" MFE to "authoring"
a5c22bc 
Existing URLs are (301, permanently) redirected to the new ones. We are
doing this because the course-authoring MFE has been migrated to a new
repository.

Close #224.
arbrandes pushed a commit that referenced this issue Oct 8, 2024
@regisb @arbrandes
feat: rename "course-authoring" MFE to "authoring"
6a00aac 
Existing URLs are (301, permanently) redirected to the new ones. We are
doing this because the course-authoring MFE has been migrated to a new
repository.

Close #224.
@arbrandes
Copy link
Collaborator

Fix just got merged.

@github-project-automation github-project-automation bot moved this from In Progress to Done in Tutor project management Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Tutor project management
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: rename "course-authoring" MFE to "authoring" overhangio/tutor-mfe
3 participants
@regisb @arbrandes @kdmccormick