[DEPR]: studio-frontend repo #381

KristinAoki · 2023-06-02T13:57:15Z

Proposal Date

02 June 2023

Ticket Acceptance Date

15 August 2023

Technology Removal Date

Before Sumac, exact date TBD

Removal blocked by openedx/edx-platform#34692

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:

accessibility.html
health check, including references from:
- checklists.html
- course status in course_outline.html
legacy files and uploads page
image upload from the legacy Text editor
- Removing the image upload is contingent on the legacy Text editor deprecation: [DEPR]: Legacy Text Editor edx-platform#34692
  - Note that this does not affect the other usages of the tinyMCE editors, eg Announcements.

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

Communicated here: https://discuss.openedx.org/t/deprecation-removal-studio-frontend-381/10280

The text was updated successfully, but these errors were encountered:

kdmccormick · 2023-06-02T13:58:30Z

I'm excited for this one 🔥

dianakhuang · 2024-04-04T15:21:14Z

@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 · 2024-04-04T15:34:34Z

@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 · 2024-04-04T15:40:00Z

@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 · 2024-04-04T15:45:21Z

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 · 2024-04-04T16:34:33Z

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 · 2024-04-04T16:36:00Z

No opposition.

kdmccormick · 2024-04-04T16:43:24Z

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

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 · 2024-04-04T16:53:02Z

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

kdmccormick · 2024-05-03T15:53:55Z

Searching for the studiofrontend tag in edx-platform, I actually see five usages of the repo:

courseHealthCheck (used by Checklists page)
courseOutlineHealthStatus (used by legacy Course Outline page)
assets (used by legacy Files and Uploads page)
editImageModal (used by legacy Text component editor)
accessibilityPolicy (used by ??? page)

I'm trying to confirm right now whether all of these pages will be enabled in Redwood and ready to remove in Sumac.

KristinAoki · 2024-05-03T16:00:54Z

courseHealthCheck (used by Checklists page)

When navigating to the Checklist page, users should automatically redirected to {course authoring host}/checklists

accessibilityPolicy (used by ??? page)

Can be found at{studio host}/accessibility and is moved to {course authoring host}/accessibility

All of the references are not yet deleted in edx-platform

kdmccormick · 2024-05-03T16:31:01Z

When navigating to the Checklist page, users should automatically redirected to {course authoring host}/checklists

Nice, thanks. Is the MFE page gated by a waffle, or enabled by default?

Can be found at{studio host}/accessibility and is moved to {course authoring host}/accessibility

Got it, thanks.

KristinAoki · 2024-05-03T16:32:16Z

It is enabled by default. It is just showing information so it was low risk to just redirect by default

kdmccormick · 2024-05-03T16:37:44Z

It is enabled by default. It is just showing information so it was low risk to just redirect by default

Sounds great @KristinAoki 👍🏻

Because studio-frontend powers the image uploader for the legacy Text component, it seems like we would need to deprecate the legacy Text editor too. Would you or someone on TNL be able to write that up?

KristinAoki · 2024-05-03T16:48:52Z

Yes, I can create the deprecation notice. Do I create the deprecation ticket in edx-platform?

kdmccormick · 2024-05-03T17:00:00Z

Yep. Thanks!

KristinAoki · 2024-05-03T17:50:20Z

Issue for legacy text editor deprecation in edx-platform, #34692

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

openedx-workflow-automation bot added this to DEPR: Deprecation & Removal Jun 2, 2023

github-project-automation bot moved this to Proposed in DEPR: Deprecation & Removal Jun 2, 2023

KristinAoki moved this from Proposed to Communicated in DEPR: Deprecation & Removal Jun 2, 2023

dianakhuang moved this from Communicated to Accepted in DEPR: Deprecation & Removal Jun 15, 2023

This was referenced Mar 4, 2024

feat: add accessibility page openedx/frontend-app-authoring#861

Merged

feat: update page renders for studio-frontend pages openedx/edx-platform#34329

Merged

feat: add checklist page openedx/frontend-app-authoring#870

Merged

KristinAoki moved this from Accepted to Removing in DEPR: Deprecation & Removal Apr 3, 2024

KristinAoki moved this from Removing to Deprecated in DEPR: Deprecation & Removal Apr 3, 2024

dianakhuang assigned KristinAoki Apr 4, 2024

kdmccormick mentioned this issue Apr 4, 2024

feat: switch to new Files & Uploads page overhangio/tutor-mfe#201

Closed

kdmccormick self-assigned this Apr 30, 2024

kdmccormick added this to Maintenance May 30, 2024

kdmccormick moved this to In Progress in Maintenance May 30, 2024

feanil moved this from In Progress to Todo in Maintenance Jun 13, 2024

kdmccormick moved this from Deprecated to Blocked in DEPR: Deprecation & Removal Jul 24, 2024

kdmccormick mentioned this issue Jul 24, 2024

[DEPR]: Legacy Text Editor openedx/edx-platform#34692

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DEPR]: studio-frontend repo #381

[DEPR]: studio-frontend repo #381

KristinAoki commented Jun 2, 2023 •

edited by kdmccormick

Loading

kdmccormick commented Jun 2, 2023

dianakhuang commented Apr 4, 2024

KristinAoki commented Apr 4, 2024 •

edited

Loading

kdmccormick commented Apr 4, 2024

KristinAoki commented Apr 4, 2024

kdmccormick commented Apr 4, 2024

KristinAoki commented Apr 4, 2024

kdmccormick commented Apr 4, 2024

kdmccormick commented Apr 4, 2024

kdmccormick commented May 3, 2024 •

edited

Loading

KristinAoki commented May 3, 2024 •

edited

Loading

kdmccormick commented May 3, 2024

KristinAoki commented May 3, 2024 •

edited

Loading

kdmccormick commented May 3, 2024

KristinAoki commented May 3, 2024

kdmccormick commented May 3, 2024

KristinAoki commented May 3, 2024 •

edited

Loading

[DEPR]: studio-frontend repo #381

[DEPR]: studio-frontend repo #381

Comments

KristinAoki commented Jun 2, 2023 • edited by kdmccormick Loading

Proposal Date

Ticket Acceptance Date

Technology Removal Date

First Open edX Named Release Without This Functionality

Rationale

Removal

Replacement

Deprecation

Migration

Additional Info

kdmccormick commented Jun 2, 2023

dianakhuang commented Apr 4, 2024

KristinAoki commented Apr 4, 2024 • edited Loading

kdmccormick commented Apr 4, 2024

KristinAoki commented Apr 4, 2024

kdmccormick commented Apr 4, 2024

KristinAoki commented Apr 4, 2024

kdmccormick commented Apr 4, 2024

kdmccormick commented Apr 4, 2024

kdmccormick commented May 3, 2024 • edited Loading

KristinAoki commented May 3, 2024 • edited Loading

kdmccormick commented May 3, 2024

KristinAoki commented May 3, 2024 • edited Loading

kdmccormick commented May 3, 2024

KristinAoki commented May 3, 2024

kdmccormick commented May 3, 2024

KristinAoki commented May 3, 2024 • edited Loading

KristinAoki commented Jun 2, 2023 •

edited by kdmccormick

Loading

KristinAoki commented Apr 4, 2024 •

edited

Loading

kdmccormick commented May 3, 2024 •

edited

Loading

KristinAoki commented May 3, 2024 •

edited

Loading

KristinAoki commented May 3, 2024 •

edited

Loading

KristinAoki commented May 3, 2024 •

edited

Loading