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

[DEPR]: studio-frontend repo #381

Open
KristinAoki opened this issue Jun 2, 2023 · 9 comments
Open

[DEPR]: studio-frontend repo #381

KristinAoki opened this issue Jun 2, 2023 · 9 comments
Assignees
Labels
depr Proposal for deprecation & removal per OEP-21

Comments

@KristinAoki
Copy link
Member

KristinAoki commented Jun 2, 2023

Proposal Date

02 June 2023

Ticket Acceptance Date

15 August 2023

Technology Removal Date

11 April 2024

First Open edX Named Release Without This Functionality

Sumac

Rationale

This repo is currently only used inside the edX Studio. The React code is imported into Django templates and rendered inside of Studio. The React code is only used on four pages, Assets, Accessibility Form, Course Outline Status, and Checklist. The pages in edX Studio are being update to use React and moved to frontend-app-course-authoring. To reduce the redundancy of two studio frontend repos, this one will be removed and the components that are not slated to be redesigned will be copied over to frontend-app-course-authoring.

Removal

The entire repo will be removed and the following references inside edx-platform:

Replacement

The majority of the code will be rewritten in frontend-app-course-authoring. The accessibility and checklist will be moved to frontend-app-course-authoring. The code won't change, but will live in the frontend-app-course-authoring.

Deprecation

No response

Migration

No response

Additional Info

No response

@github-actions github-actions bot added the depr Proposal for deprecation & removal per OEP-21 label Jun 2, 2023
@kdmccormick
Copy link
Member

I'm excited for this one 🔥

@dianakhuang
Copy link

@KristinAoki We are in the process of assigning owners for DEPR tickets to ensure that we have a point of contact on the current status of them. I assigned you to this one since you seem to be handling most of the movement of the ticket. Out of curiosity, why is this in 'deprecated' instead of 'removing'? Is it just because we're not doing active work on it?

@KristinAoki
Copy link
Member Author

KristinAoki commented Apr 4, 2024

@dianakhuang I was not fully sure which it belonged under. The code has been moved to course authoring, but the act of removing the repo and references to it in edx-platform has not begun

@kdmccormick
Copy link
Member

@KristinAoki , I think Deprecated is the right status. I see you marked it as deprecated already, which is great.

How can we move it forward? Ideally, 1 release should go by where both the old pages and the new pages are available for operators to use; has that happened yet? And are the new pages at feature-parity with the old pages?

If it's Yes on both counts, then your team or anyone else in the community would be all-clear to start removing studio-frontend.

@KristinAoki
Copy link
Member Author

Redwood will be the first release with the new pages and the old pages. The old pages for the Checklist page and the Accessibility Request page have redirects in edx-plaform that always redirect to the new page. The Files and Uploads page redirect can be toggled with the contentstore.new_studio_mfe.use_new_files_uploads_page waffle flag. The new pages are at feature-parity with the old pages.

@kdmccormick
Copy link
Member

Awesome! Do you have any opposition if Tutor toggles on the new Files & Uploads page by default? We could add opt-out instructions to the Redwood release notes. That would allow removal to begin as early as the day after the Redwood cut date.

@KristinAoki
Copy link
Member Author

No opposition.

@kdmccormick
Copy link
Member

Cool, I will take care of making sure Tutor runs the new page in Redwood, can you update the timeline in the issue description?

kdmccormick added a commit to kdmccormick/tutor-mfe that referenced this issue Apr 4, 2024
In Studio, this switches from the Django-rendered Files &
Uploads page to the new version of the page in the
course-authoring MFE. 

Operators can opt-out for Redwood by disabling the
`contentstore.new_studio_mfe.use_new_files_uploads_page`
flag, either per-course or site-wide. Operators can
also still disable the course-authoring MFE entirely.
However, starting in Sumac, this option will be removed
for the Files & Uploads page (and potentially for other pages)
so we recommend that operators switch to the new page
during Redwood.

Part of: openedx/studio-frontend#381
@kdmccormick
Copy link
Member

Thanks Kristin. Here's where I'll be working on adding this to Tutor: overhangio/tutor-mfe#201

@kdmccormick kdmccormick self-assigned this Apr 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
depr Proposal for deprecation & removal per OEP-21
Projects
Status: Deprecated
Development

No branches or pull requests

3 participants