This page is a work in progress by DEPR WG.]
This page does not include legacy pages without MFE reimplementationsSee also: this initiative and its child tickets.
Table of contents:
| Table of Contents | ||
|---|---|---|
|
List of legacy pages with replacements in an MFE
...
IDA/Service
...
Page
...
Toggle(Waffle)
...
Old URL
...
New MFE & URL
...
DEPR Link (if it exists)
...
Status/Notes
...
CMS
...
Course Custom Pages Page
...
contentstore.new_studio_mfe.use_new_custom_pages
...
{STUDIO_BASE}/tabs/<course-id>
...
Replacement Statuses
More than one can apply!
Status title Not started Status colour Red title needs improvement Status colour Yellow title in development Status colour Green title parity achieved Status colour Blue title Live on edx.org Status colour Purple title Default in
...
CMS
...
Course advanced settings page
...
contentstore.new_studio_mfe.use_new_advanced_settings_page
...
{STUDIO_BASE}/settings/advanced/{course_id]
...
{AUTHORING_BASE}/course-id>
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course Schedule & Details page
...
contentstore.new_studio_mfe.use_new_schedule_details_page
...
{STUDIO_BASE}/settings/details/{course_id}
...
{AUTHORING_BASE}/course/ <course-id>/settings/details
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course grading page
...
contentstore.new_studio_mfe.use_new_grading_page
...
{STUDIO_BASE}/settings/grading/{course_id}
...
{AUTHORING_BASE}/course/ <course-id>/settings/grading
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course updates page
...
contentstore.new_studio_mfe.use_new_updates_page
...
{STUDIO_BASE}/course_info/{course_id}
...
{AUTHORING_BASE}/course/ <course-id>/course_info
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course Import page
...
contentstore.new_studio_mfe.use_new_import_page
...
{STUDIO_BASE}/import/{course_id}
...
{AUTHORING_BASE}/course/ <course-id>/import
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Open edX Status title LEGACY REMOVED!
The Big List: All Known Legacy Pages, With and Without MFEs Replacements
...
Frontend Pages in edx-platform
...
Page | Old (Backend Service & Path) | New (MFE & Path) | Toggle (Waffle Flag) | Status, DEPR Link, Repo Links, Product Review Links, Other Notes | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Studio: Logged-out Landing Page | CMS
|
| TBD |
| ||||||||||||
Studio: Preview | LMS-Preview
| frontend-app-learning OR frontend-app-authoring
| TBD |
https://github.com/openedx/frontend-app-learning/issues/1455 This is the only thing blocking the removal of legacy Courseware Sequence view.
| ||||||||||||
Studio: Course Custom Pages | CMS
|
|
|
|
{STUDIO_BASE}/export/{course_id}
{AUTHORING_BASE}/course/ <course-id>/export
|
|
CMS
Course Video Uploads Page
Should be part of 2Us DEPR around Studio Frontend MFE
| |||
Studio: Course advanced settings | CMS
|
|
|
|
{STUDIO_BASE}/videos/{course_id}
{AUTHORING_BASE}/course/ <course-id>/videos
|
EXTRA CONFIG IN .env
ENABLE_VIDEO_UPLOAD_PAGE_LINK_IN_CONTENT_DROPDOWN=true
|
Default in Redwood (needs confirmation)
CMS
Course Files & Uploads Page
contentstore.new_studio_mfe.use_new_files_uploads_page
CMS
Studio Home Page
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||
Studio: Course Schedule & Details | CMS
|
{AUTHORING_BASE}/course/ <course-id>/assets
Live on edx.org
Default in Redwood (needs confirmation)
|
|
|
{STUDIO_BASE}/home/
{AUTHORING_BASE}/home
|
CMS
Course content outline page
Should be part of 2Us DEPR around Studio Frontend MFE | |||
Studio: Course grading | CMS
|
|
|
|
{STUDIO_BASE}/course/{course_id}
|
|
As of May-2024
Not Live on http://edx.org
Not live on edge.edx.org
Default in Redwood (needs confirmation)
CMS
Course unit pages
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||
Studio: Course updates | CMS
|
|
|
{AUTHORING_BASE}/course/<course-id>/container/{usage_key_string}
|
{STUDIO_BASE}/container/{usage_key_string}
|
|
Not default in Redwood
CMS
Course Team page
contentstore.new_studio_mfe.use_new_course_team_page
Should be part of 2Us DEPR around Studio Frontend MFE | |||||||||
Studio: Course Import | CMS
|
|
Live on edx.org
CMS
Course Textbooks Page
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||
Studio: Course Export | CMS
|
|
| Status | ||||
|---|---|---|---|---|
|
CMS
Course Group Configurations
|
|
|
{STUDIO_BASE}/group_configurations/{course_id}
{AUTHORING_BASE}/course/<course-id>/group_configurations
|
|
CMS
Course Studio: Page & Resources
{AUTHORING_BASE}/course/<course-id>/pages-and-resources
|
|
replacement:
Should be part of 2Us DEPR around Studio Frontend MFE | ||
Studio: Course Video Uploads | CMS
|
Default in Redwood (needs confirmation)
CMS
Library Studio
(all pages)
{STUDIO_BASE}/home_library
{STUDIO_BASE}/library/*
{AUTHORING_BASE}/...routes TBD.../
In development: Schema, OpenCraft, and Axim.
Not default in Redwood
(Slack: #content-libraries-relaunch-dev)
LMS
Course Dashboard
aka Learner Dashboard
aka Learner Home
`
{LMS_BASE}/dashboard
{LEARNER_HOME_BASE}/
NEED
completed: 2024
squad: aurora, then aperture
[BD-08] B2C Learner Dashboard MFE Conversion
Default in Quince
LMS
Login/Registration
Also works with .underscore files
|
EXTRA CONFIG IN .env
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||
Studio: Course Files & Uploads | CMS
|
|
|
|
Default as of ~M/N/O release
LMS
Profile
started: 2019-Jan
rolled out (mvp): 2019-Mar
completed (~parity): pending linking from header in Edge
Default in ??
LMS
Account Settings
started: 2019-Jan
rolled out (mvp): 2019-Mar
completed (~parity): pending linking from header in Edge
Default in ??
LMS?
ID Verification
| Jira Legacy | ||||||
|---|---|---|---|---|---|---|
|
started: 2020-Apr-16
rolled out (mvp): 2020-Jul-24
completed (~parity): 2020-Nov-1
removed old: hold
LMS
Course Home: Dates
| Status | ||||
|---|---|---|---|---|
|
LMS
Course Home: Outline
| Status | ||||
|---|---|---|---|---|
|
LMS
Course Home: Progress
LMS
Courseware: Sequence & Unit
started: 2020-Jan
rolled out (mvp): 2020-Sep
completed (~parity)(Prod): 2021-Jun
completed (~parity)(Edge): 2022-Feb
removed old:
Blocked by studio course preview, which doesn’t work in learning mfe
LMS
Courseware: Proctored Exam
status: launched
team: cosmonauts
Replacement repo:
LMS
Courseware: Search
| Status | ||
|---|---|---|
|
LMS
Track Selection
| Status | ||||
|---|---|---|---|---|
|
LMS
Course Messaging
ecommerce
Basket / Payment
| Status | ||||
|---|---|---|---|---|
|
repo: https://github.com/edx/frontend-app-payment
started: 2019-June
rolled out (mvp): 2019-Aug
completed (~parity): 2019-Sep
removed old:
ecommerce
Order History
| Status | ||||
|---|---|---|---|---|
|
repo: https://github.com/edx/frontend-app-ecommerce
started: 2019-Apr
rolled out (mvp): 2019-Apr
completed (~parity): 2019-May
removed old:
LMS
Discussions
| Status | ||||
|---|---|---|---|---|
|
repo: https://github.com/edx/frontend-app-discussions
started:
rolled out (mvp):
completed (~parity):
removed old:
Credentials
Learner Record
| Status | ||||
|---|---|---|---|---|
|
repo: https://github.com/openedx/frontend-app-learner-record
started: 2021-Jul
rolled out (mvp):
completed (~parity):
removed old:
Reference: What MFEs are there?
The full list of Open edX MFEs, including ones that are experimental or under development, can be found by searching “frontend-app-” in the openedx GitHub org: https://github.com/orgs/openedx/repositories?q=frontend-app-
The list of Open edX MFEs that run out-of-the-box in Tutor can be found by looking at the CORE_MFE_APPS variable in the tutor-mfe plugin’s plugin.py file:
[upcoming release / tutor nightly] https://github.com/overhangio/tutor-mfe/blob/nightly/tutormfe/plugin.py#L33
[latest release / tutor master] https://github.com/overhangio/tutor-mfe/blob/master/tutormfe/plugin.py#L33
Reference: MFE Base URLs
MFEs follow a simple naming pattern. Given some lowercase hyphen based name{APPNAME} (for example, learning)….
The repo is
https://github.com/openedx/{APPNAME}Example:
https://github.com/openedx/frontend-app-learning
The base URL in Tutor is
https://apps.{LMS_BASE}/{APPNAME}Example:
https://apps.myopenedx.site/learning
The base URL on edX is
https://{APPNAME}.edx.orgExample:
https://learning.edx.orgEXCEPTION: For
learner-dashboard, the URL is nothttps://learner-dashboard.edx.org. Instead, it’shttps://home.edx.org.
More References
Should also be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||
Studio: Logged-in Home Page | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||
Studio: Course content outline editor | CMS
|
|
As of May-2024:
| |||||||||||||||||||||||
Studio: Unit editor | CMS
|
|
|
| ||||||||||||||||||||||
Studio: Course Team | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||
Studio: Course Textbooks | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||
Studio: Course Group Configurations | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||
Studio: Page & Resources | CMS
|
|
|
| ||||||||||||||||||||||
Studio: Text (HTML) Editor | CMS
|
|
|
| ||||||||||||||||||||||
Studio: Problem (CAPA) Editor |
|
|
|
| ||||||||||||||||||||||
Studio: Video Editor |
|
|
|
| ||||||||||||||||||||||
Studio: Library Authoring (all pages) | CMS
|
| In Django settings:
|
In development: Schema, OpenCraft, and Axim. (Slack: #content-libraries-relaunch-dev) | ||||||||||||||||||||||
Studio: Maintenance | CMS
| frontend-app-authoring ??? |
| |||||||||||||||||||||||
Studio: Maintenance: Announcements | CMS
| frontend-app-authoring ??? |
| |||||||||||||||||||||||
Studio: Maintenance: Force Publish Course | CMS
| frontend-app-authoring ??? |
| |||||||||||||||||||||||
Studio: Update Preview Language | CMS
| frontend-app-authoring ??? |
Note: This doesn’t seem to be accessed on studio.edx.org ? | |||||||||||||||||||||||
Course Dashboard aka Learner Dashboard aka Learner Home | LMS
| frontend-app-learner-dashboard
|
|
[BD-08] B2C Learner Dashboard MFE Conversion https://github.com/openedx/edx-platform/issues/35326 Note: This is only the learner course dashboard. The learner programs dashboard does not have an MFE replacement yet. | ||||||||||||||||||||||
Login/Registration | LMS
|
|
|
https://github.com/openedx/public-engineering/issues/81 MISSING FEATURE IN MFE: Custom registration fields.
| ||||||||||||||||||||||
Profile | LMS
|
| ??? |
| ||||||||||||||||||||||
Account Settings | LMS
|
| ??? |
| ||||||||||||||||||||||
ID Verification | LMS
| frontend-app-???
| ??? |
Unclear whether live in named release. Needs DEPR. | ||||||||||||||||||||||
Course Home: Dates | LMS
| frontend-app-learning
| N/A |
| ||||||||||||||||||||||
Course Home: Outline | `LMS
| frontend-app-learning
| N/A |
| ||||||||||||||||||||||
Course Home: Progress | LMS
| frontend-app-learning
|
|
Needs a DEPR The MFE displays grades under some circumstances where the old progress page did not. MIT is using the course waffle flag to disable the MFE for some courses on edx.org. | ||||||||||||||||||||||
Course Home: Custom Pages | LMS
| frontend-app-learning
| TBD |
This is low hanging fruit! We just need to make a course home tab view that iframes in the CustomTabBlock, which is just an HtmlBlock subclass! This could be done at parity quickly. I don’t think it warrants a DEPR. We should ticket this up with the | ||||||||||||||||||||||
Courseware: Sequence | LMS
| frontend-app-learning
| N/A |
Legacy is partially removed. Full removal is blocked by studio course preview, which doesn’t yet work in learning mfe. | ||||||||||||||||||||||
Courseware: render_xblock | LMS
| LMS
| N/A |
This is the endpoint that renders a “chromeless” (nav-free) xblock. This will never be removed entirely but, eventually, we can seriously simplify it to the point where it’s just a thin wrapper around the next item (built-in XBlock views). | ||||||||||||||||||||||
Courseware: Built-in XBlock Views | edx-platform
| xblocks-contrib
|
|
https://github.com/openedx/edx-platform/issues/34827 These views will not be turned into MFE pages, but they will be extracted out of edx-platform and into: https://github.com/openedx/xblocks-contrib/ | ||||||||||||||||||||||
Courseware: Proctored Exam | LMS
| frontend-app-learning (via frontend-lib-special-exams)
|
https://github.com/openedx/edx-proctoring/issues/1226 Replacement repo: | |||||||||||||||||||||||
Courseware: Search | LMS Dave: I don’t think this is actually reachable any longer, since we force you into the MFE experience for that courseware page view. | frontend-app-learning
|
| NEED DISCOVERY: is this at parity? is it live for edx.org, open edx? | ||||||||||||||||||||||
Program Dashboard | LMS
| TBD
|
| |||||||||||||||||||||||
Course Certificates | LMS
| TBD
|
| |||||||||||||||||||||||
Program Certificates | Credentials
| TBD
|
| |||||||||||||||||||||||
Track Selection | LMS
| TBD
|
| NEEDS DISCOVERY: What is the status? Do we rewrite or DEPR? | ||||||||||||||||||||||
Course Messaging | LMS
| TBD
| NEEDS DISCOVERY: What is the status? | |||||||||||||||||||||||
Basket / Payment | Ecommerce
| frontend-app-order-history
|
NEEDS DISCOVERY: Is replacement enabled in open edx? Is it at parity? | |||||||||||||||||||||||
Order History | Ecommerce
| frontend-app-ecommerce
|
NEEDS DISCOVERY: Is replacement enabled in open edx? Is it at parity? | |||||||||||||||||||||||
Discussions | LMS
|
|
NEEDS DEPR NEEDS DISCOVERY: Is this sufficiently at parity? | |||||||||||||||||||||||
Learner Record | Credentials
|
|
Replacement: | |||||||||||||||||||||||
Instructor Dashboard (all pages) | LMS
| frontend-app-gradebook (should be renamed to frontend-app-instruction, or something) |
Should subsume | |||||||||||||||||||||||
Discover New Courses | LMS
| frontend-app-catalog?
|
| |||||||||||||||||||||||
Course About | LMS
| frontend-app-catalog?
|
|
Reference: What MFEs are there?
The full list of Open edX MFEs, including ones that are experimental or under development, can be found by searching “frontend-app-” in the openedx GitHub org: https://github.com/orgs/openedx/repositories?q=frontend-app-
The list of Open edX MFEs that run out-of-the-box in Tutor can be found by looking at the CORE_MFE_APPS variable in the tutor-mfe plugin’s plugin.py file:
[upcoming release / tutor nightly] https://github.com/overhangio/tutor-mfe/blob/nightly/tutormfe/plugin.py#L33
[latest release / tutor master] https://github.com/overhangio/tutor-mfe/blob/master/tutormfe/plugin.py#L33
Reference: MFE Base URLs
MFEs follow a simple naming pattern. Given some lowercase hyphen based name{APPNAME} (for example, learning)….
The repo is
https://github.com/openedx/frontend-app-{APPNAME}Example:
https://github.com/openedx/frontend-app-learning
The base URL in Tutor is
https://apps.{LMS}/{APPNAME}Example:
https://apps.myopenedx.site/learning
The base URL on edX is
https://{APPNAME}.edx.orgExample:
https://learning.edx.orgEXCEPTION: For
learner-dashboard, the URL is nothttps://learner-dashboard.edx.org. Instead, it’shttps://home.edx.org.
Robert’s DataDog Query for CMS Frontends
2U is contributing some monitoring findings to help us determine the legacy frontends that are still in the platform…
| Code Block |
|---|
-@view.url_path:(/course/course-v1\:* OR /c4x/* OR /container/block-v1\:* OR /library/library-v1\:* OR /preview/xblock/block-v1\:* OR /asset-v1\:* OR /course_team/course-v1\:* OR /certificates/course-v1\:* OR /settings/grading/* OR /settings/details/* OR /settings/advanced/* OR /group_configurations/course-v1\:* OR /import/library-v1\:* OR /import/course-v1\:* OR /textbooks/course-v1\:* OR /tabs/course-v1\:* OR /export/course-v1\:* OR /admin/split_modulestore_django/* OR /admin/*) |
edX.org CMS Result:
| Code Block |
|---|
/
/home_library
/admin
/maintenance
/maintenance/announcements |
More References
Old archived Version of this: [Archive] MFE Rewrite Status
https://docs.google.com/spreadsheets/d/1X81NJB20hcBHcfsswenP5FhECe1w1LzXWrBlga4RmX4/edit?gid=0#gid=0 - these are edx-platform views seen/accessed on edx.org