This page is a work in progress by DEPR WG.]
This page does not include legacy pages without MFE reimplementations. If you want to see the whole darn list, look at See also: this initiative and its child tickets.
...
Table of Contents | ||
---|---|---|
|
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
...
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
...
{CMS}/tabs/<course-id>
...
{COURSE_AUTHORING}/<course-id>/custom-pages
...
Should be part of 2Us DEPR around Studio Frontend MFE
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course advanced settings page
...
contentstore.new_studio_mfe.use_new_advanced_settings_page
...
{CMS}/settings/advanced/{course_id]
...
{COURSE_AUTHORING}/course-id>
...
Should be part of 2Us DEPR around Studio Frontend MFE
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course Schedule & Details page
...
contentstore.new_studio_mfe.use_new_schedule_details_page
...
{CMS}/settings/details/{course_id}
...
{COURSE_AUTHORING}/course/ <course-id>/settings/details
...
Should be part of 2Us DEPR around Studio Frontend MFE
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course grading page
...
contentstore.new_studio_mfe.use_new_grading_page
...
{CMS}/settings/grading/{course_id}
...
{COURSE_AUTHORING}/course/ <course-id>/settings/grading
...
Should be part of 2Us DEPR around Studio Frontend MFE
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course updates page
...
contentstore.new_studio_mfe.use_new_updates_page
...
{CMS}/course_info/{course_id}
...
{COURSE_AUTHORING}/course/ <course-id>/course_info
...
Should be part of 2Us DEPR around Studio Frontend MFE
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
Course Import page
...
contentstore.new_studio_mfe.use_new_import_page
...
{CMS}/import/{course_id}
...
{COURSE_AUTHORING}/course/ <course-id>/import
...
Should be part of 2Us DEPR around Studio Frontend MFE
...
Live on edx.org
Default in Redwood (needs confirmation)
...
CMS
...
achieved Status colour Blue title Live on edx.org Status colour Purple title Default in Open edX Status title LEGACY REMOVED!
The Big List: All Known Legacy Pages, With and Without MFEs Replacements
...
LMS
...
Instructor Dashboard
...
Gradebook MFE should be combined into this one.
...
LMS
...
LMS Course Explore
...
Might be a new MFE
...
LMS
...
Course About
...
LMS
...
Program Dashboard
...
courses.TLD/dashboard/programs/
...
LMS
...
Course Certificates
...
courses.TLD/certificates/[id[
...
Credentials
...
Program Certificates
...
credentials.TLD/credentials/[id]
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.org
Example:
https://learning.edx.org
EXCEPTION: For
learner-dashboard
, the URL is nothttps://learner-dashboard.edx.org
. Instead, it’shttps://home.edx.org
.
More References
...
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
|
|
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE Live on edx.org Default in Redwood (needs confirmation) | CMS | Course Video Uploads Page
| |||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course advanced settings | CMS
|
|
EXTRA CONFIG IN .env
|
|
| Should be part of 2Us DEPR around Studio Frontend MFE | Live on edx.org Default in Redwood (needs confirmation) | ||||||||||||||||||||||||||||||||||||||||||||||||||
CMS | Course Files & Uploads Page |
|
|
| https://github.com/openedx/studio-frontend/issues/381 Should be part of 2Us DEPR around Studio Frontend MFE | Live on edx.org Default in Redwood (needs confirmation) | |||||||||||||||||||||||||||||||||||||||||||||||||||
CMS | Studio Home Page (logged in) |
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Schedule & Details | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | Live on edx.org Default in Redwood (needs confirmation) | CMS | Course content outline page | ||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course grading | CMS
|
|
|
| Should be part of 2Us DEPR around Studio Frontend MFE |
Not live on edge.edx.org Default in Redwood (needs confirmation) | CMS | Course unit page
Should be part of 2Us DEPR around Studio Frontend MFE | |||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course updates | CMS
|
|
|
|
|
Not default in Redwood Too early for a DEPR ticket. | CMS | Course Team page |
|
|
Should be part of 2Us DEPR around Studio Frontend MFE Live on edx.org | CMS | |||||||||||||||||||||||||||||||||||||||||||||
Course Textbooks PageStudio: Course Import | CMS
|
|
|
|
| Should
Should be part of 2Us DEPR around Studio Frontend MFE | |||||||||||||||||||||||||||||||||||||||||||||||||||
Default in RedwoodStudio: Course Export | CMS | Course Group Configurations |
|
|
|
| Should be part of 2Us DEPR around Studio Frontend MFE | CMS | Course Studio: Page & Resources |
|
| https://github.com/openedx/edx-platform/issues/35254 status: |
|
replacement: frontend-app-course-authoring Default in Redwood (needs confirmation) There might be some related waffle flags for this in discussions. | CMS | Studio Editors: Text (HTML) | CMS | Studio Editors: Problem (CAPA) | CMS | Studio Editors: VIdeo | CMS | Library Studio (all pages) |
|
| In development: Schema, OpenCraft, and Axim. Not default in Redwood (Slack: #content-libraries-relaunch-dev) | LMS | Course Dashboard aka Learner Dashboard aka Learner Home | ` |
| completed: 2024 squad: aurora, then aperture [BD-08] B2C Learner Dashboard MFE Conversion Default in Quince Note: This is only the learner course dashboard. The learner programs dashboard does not have an MFE replacement yet. | LMS | Login/Registration
Should be part of 2Us DEPR around Studio Frontend MFE | |||||||||||||||||||||||||
Studio: Course Video Uploads | CMS
|
|
EXTRA CONFIG IN .env
|
Should be part of 2Us DEPR around Studio Frontend MFE | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Files & Uploads | CMS
|
|
| LMS | Course Home: Dates | status: |
Status | ||||
---|---|---|---|---|
|
LMS
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
https://github.com/openedx/publicstudio-engineeringfrontend/issues/81
Default as of ~M/N/O release
Also works with .underscore files
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
Should also be part of 2Us DEPR around Studio Frontend MFE
Studio: Logged-in Home Page
CMS
/home/
/home
new_studio_mfe.use_new_home_page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Should be part of 2Us DEPR around Studio Frontend MFE
Studio: Course content outline editor
CMS
/course/{course_id}
contentstore.new_studio_mfe.use_new_course_outline_page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
As of May-2024:
in Beta Testing on edx.org
Not live on edge.edx.org
Studio: Unit editor
CMS
/container/{usage_key_string}
/course/{course_id}/container/{usage_key_string}
contentstore.new_studio_mfe.use_new_unit_page
Status | ||||
---|---|---|---|---|
|
https://github.com/openedx/publicedx-engineeringplatform/issues/5035261
statusStudio: Course Team
Status
/course_team/{course_id}
/course/{course_id}/course_team
contentstore.new_studio_mfe.use_new_course_team_page
LMS
Track Selection
Status | ||||
---|---|---|---|---|
|
course_modes.use_new_track_selection
exists
LMS
Course Messaging
ecommerce
Basket / Payment
Status | ||||
---|---|---|---|---|
|
repo: https://github.com/edx/frontend-app-payment
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 | ||
---|---|---|
|
courseware.mfe_courseware_search
Dave: I don’t think this is actually reachable any longer, since we force you into the MFE experience for that courseware page view.
{LEARNING}/course/{course-key}/home?q=search-term
Unreviewed Below Here
|
Status | ||||
---|---|---|---|---|
|
Should be part of 2Us DEPR around Studio Frontend MFE
Studio: Course Textbooks
CMS
/textbooks/{course_id}
/course/{course_id}/textbooks
contentstore.new_studio_mfe.use_new_textbooks_page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Should be part of 2Us DEPR around Studio Frontend MFE
Studio: Course Group Configurations
CMS
/group_configurations/{course_id}
/course/{course_id}/group_configurations
contentstore.new_studio_mfe.use_new_group_configurations_page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Should be part of 2Us DEPR around Studio Frontend MFE
Studio: Page & Resources
CMS
/???
/course/{course_id}/pages-and-resources
discussions.pages_and_resources_mfe
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
https://github.com/openedx/publicedx-engineeringplatform/issues/6835254
started: 2019-June
rolled out (mvp): 2019-Aug
completed (~parity): 2019-Sep
removed old:
ecommerce
Order History
Studio: Text (HTML) Editor
CMS
/???
/???
new_core_editors.use_new_text_editor
repo:
Status | ||||
---|---|---|---|---|
|
Status | |||
---|---|---|---|
|
|
started: 2019-Apr
rolled out (mvp): 2019-Apr
completed (~parity): 2019-May
removed old:
LMS
Discussions
status: -platform/issues/34692
Studio: Problem (CAPA) Editor
/???
/???
new_core_editors.use_new_problem_editor
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
repo:
|
Studio: Video Editor
/???
Credentials
Learner Record
frontend-app-course-discussions
started:
rolled out (mvp):
completed (~parity):
removed old:
/???
new_core_editors.use_new_video_editor
Status | ||||
---|---|---|---|---|
|
Status | |||
---|---|---|---|
|
|
started: 2021-Jul
rolled out (mvp):
completed (~parity):
removed old:
LMS Preview for studio
Should this go here or do we need further development? Do we need this anymore now that we have preview at the unit level? or is the navigation in a preview full LMS still valuable?
All Views with No MFEs Currently
...
IDA/Service
...
Page
...
URL
...
Ideal MFE Target
...
DEPR
...
Notes
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.org
Example:
https://learning.edx.org
EXCEPTION: 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