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.

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

Rename this repo to frontend-app-authoring #1250

Closed
kdmccormick opened this issue Sep 3, 2024 · 2 comments
Closed

Rename this repo to frontend-app-authoring #1250

kdmccormick opened this issue Sep 3, 2024 · 2 comments
Assignees

Comments

@kdmccormick
Copy link
Member

kdmccormick commented Sep 3, 2024

Rationale

Originally, the idea was that there's be three authoring MFEs: one for courses, one for libraries, one for taxonomies. We even had a separate frontend-lib-content-components repo so that editors could be shared amongst the MFEs.

That did not pan out. Four repos creates a lot of maintenance overhead and coordination overhead. It is also difficult to keep the "Studio" UX feel consistent across three frontends. So, we decided that all authoring frontends will live directly in this repo (frontend-app-course-authoring).

Taxnomy authoring was already built into this repo. The core editors (html, video, problem) were moved into this repo. Starting in Sumac, the entire library authoring experience will be moved into this repo.

So, in the interest of having names that make sense, I propose that we rename this repo to frontend-app-authoring. I am interested in doing this in advance of the Sumac release, giving BTR and Tutor maintainers time to react to the change.

Logistics

For Everybody: As long as you don't create a new repo at the old URL, GitHub dutifully forwards URLs and git refs forever. So, as long as we never make another repo named openedx/frontend-app-course-authoring, we should be safe to rename this to openedx/frontend-app-authoring, and nobody's pipelines or development workflows should be disrupted. For this reason, I do not see this as a breaking change for Open edX.

For Tutor users: For consistency's sake, it could be good rename tutor-mfe's course-authoring frontend to authoring . This would be a breaking change to any Tutor plugins which depend on the course-authoring APP_NAME, so I leave it to the discretion of tutor-mfe maintainer. Furthermore, in order to avoid breaking URLs: if canonical URLs change from /course-authoring/* to /authoring/*, then we'd want to stick a bit into the MFE Caddyfile patch to ensure that the former forwards to the latter forever.

Timeline:

  • 10-day comment period begins now
  • Fri 2024-09-13: last call for concerns
  • Mon 2024-09-16: if no blocking concerns, repo is renamed
  • (Wed 2024-10-09: earliest possible Sumac cutoff)

Key stakeholders:

  • Repo maintainers: @jristau1984 and team
  • Repo CCs: @openedx/committers-frontend @openedx/committers-frontend-app-course-authoring
  • Tutor-MFE maintainer: @arbrandes
@kdmccormick
Copy link
Member Author

Done!

Can someone review this small PR to update the README?

Also, here's a followup issue in tutor-mfe:

@kdmccormick
Copy link
Member Author

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant