This page is a work in progress by DEPR WG.
...
title | MFE URL/Repo Reference |
---|
...
URL key
...
Repo
...
Tutor URL
...
edX.org
...
{AUTHORING_BASE}
...
https://github.com/openedx/course-authoring
...
https://apps.{LMS_BASE}/course-authoring
...
https://course-authoring.edx.org
...
{LEARNING_BASE}
...
https://github.com/openedx/learning
...
https://apps.{LMS_BASE}/learning
...
...
{LEARNER_DASHBOARD_BASE}
...
https://github.com/openedx/learner-dashboard
...
https://apps.{LMS_BASE}/learner-dashboard
...
...
{AUTHN_BASE}
...
https://github.com/openedx/authn
...
https://apps.{LMS_BASE}/authn
...
...
{ACCOUNT_BASE}
...
https://github.com/openedx/account
...
https://apps.{LMS_BASE}/account
...
...
{PROFILE_BASE}
...
https://github.com/openedx/profile
...
https://apps.{LMS_BASE}/profile
...
...
{COMMUNICATIONS_BASE}
...
https://github.com/openedx/communication
...
https://apps.{LMS_BASE}/communication
...
???
...
See also: this initiative and its child tickets.
Table of contents:
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 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
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://apps.{LMS_BASE}/ora-grading
...
???
IDA | Studio Page | Toggle(Waffle) | Old URL | New MFE & URL | DEPR | Notes | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CMS | Course Custom Pages Page |
|
|
| Live on edx.org | CMS | Course advanced settings pagefrontend-app-learning/issues/1455 This is the only thing blocking the removal of legacy Courseware Sequence view.
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Custom Pages | CMS
|
|
|
|
|
| CMS | Course Schedule & Details page |
|
Should be part of 2Us DEPR around Studio Frontend MFE
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course advanced settings | CMS | Course grading page | CMS
|
| Live on edx.org |
|
|
|
|
|
| CMS | Course Import page |
| {STUDIO_BASE}/import
| Course updates page |
|
|
| Live on edx.org |
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Schedule & Details | CMS
|
| Live on edx.org | CMS | Course Export pagefrontend-app-course-authoring
|
|
|
|
| CMS | Course Video Uploads Page |
EXTRA CONFIG IN .env
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course grading | CMS
| CMS | Course Files & Uploads Page |
| Live on edx.org |
|
|
|
|
| Studio Home Page |
|
|
| Live on edx.org | CMS |
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course updates | CMS
|
|
|
As of May-2024
Not live on edge.edx.org Live in Tutor as of Redwood | CMS |
|
|
|
|
| CMS | Course Team page |
|
|
| Live on edx.org | CMS | Course Textbooks Page |
|
|
|
| CMS | Course Group Configurations |
|
|
|
| CMS | Course Studio: Page & Resources |
| status:
Status | ||||
---|---|---|---|---|
|
replacement: frontend-app-course-authoring
CMS
Library Studio
(all pages)
{STUDIO_BASE}/home_library
{STUDIO_BASE}/library/*
{AUTHORING_BASE}/...routes TBD.../
In development: Schema, OpenCraft, and Axim.
(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
LMS
Login/Registration
started: 2020-Oct
rolled out (mvp): 2021-Mar
completed (~parity):
removed old:
https://github.com/openedx/edx-platform/blob/38320f8433427111c6cfb2bfaaa70aec5b989053/lms/templates/student_account/login_and_register.htmlAlso works with .underscore files
Status | ||||
---|---|---|---|---|
|
Should be part of 2Us DEPR around Studio Frontend MFE
Studio: Course Import
CMS
/import/{course_id}
/course/{course_id}/import
contentstore.new_studio_mfe.use_new_import_page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Should be part of 2Us DEPR around Studio Frontend MFE
Studio: Course Export
CMS
/export/{course_id}
/course/{course_id}/export
contentstore.new_studio_mfe.use_new_export_page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Should be part of 2Us DEPR around Studio Frontend MFE
Studio: Course Video Uploads
CMS
/videos/{course_id}
/course/{course_id}/videos
contentstore.new_studio_mfe.use_new_video_uploads_page
EXTRA CONFIG IN .env
ENABLE_VIDEO_UPLOAD_PAGE_LINK_IN_CONTENT_DROPDOWN=true
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Should be part of 2Us DEPR around Studio Frontend MFE
Studio: Course Files & Uploads
CMS
/assets/{course_id}
/course/{course_id}/assets
contentstore.new_studio_mfe.use_new_files_uploads_page
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
https://github.com/openedx/studio-frontend/issues/381
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 | ||||
---|---|---|---|---|
|
Studio: Course Team
CMS
/course_team/{course_id}
/course/{course_id}/course_team
contentstore.new_studio_mfe.use_new_course_team_page
Status | ||||
---|---|---|---|---|
|
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 | ||||
---|---|---|---|---|
|
Studio: Text (HTML) Editor
CMS
/???
/???
new_core_editors.use_new_text_editor
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Studio: Problem (CAPA) Editor
/???
/???
new_core_editors.use_new_problem_editor
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Studio: Video Editor
/???
/???
new_core_editors.use_new_video_editor
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Studio: Library Authoring
(all pages)
CMS
/home_library
/library/*
/???
In Django settings:
MFE_CONFIG_OVERRIDES.setdefault('course-authoring', {})['LIBRARY_MODE'] = 'mixed'
Status | ||||
---|---|---|---|---|
|
In development: Schema, OpenCraft, and Axim.
(Slack: #content-libraries-relaunch-dev)
Studio: Maintenance
CMS
/maintenance
frontend-app-authoring
???
Status | ||
---|---|---|
|
Studio: Maintenance: Announcements
CMS
/maintenance/anouncements
frontend-app-authoring
???
Status | ||
---|---|---|
|
Studio: Maintenance: Force Publish Course
CMS
/maintenance/announcements/force_publish_course
frontend-app-authoring
???
Status | ||
---|---|---|
|
Studio: Update Preview Language
CMS
/update_lang
frontend-app-authoring
???
Status | ||
---|---|---|
|
Note: This doesn’t seem to be accessed on studio.edx.org ?
Course Dashboard
aka Learner Dashboard
aka Learner Home
LMS
/dashboard
frontend-app-learner-dashboard
/???
learner_home_mfe.enabled
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
[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
/login
/register
/password_assistance
/login
/register
/reset
FEATURES['ENABLE_AUTHN_MICROFRONTEND']
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
https://github.com/openedx/public-engineering/issues/81
MISSING FEATURE IN MFE: Custom registration fields.
Also works with .underscore files
Profile
LMS
/u/{username}
/u/{username}
???
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Account Settings
LMS
/???
/
???
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
ID Verification
LMS
/???
frontend-app-???
/???
???
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Unclear whether live in named release.
Needs DEPR.
Course Home: Dates
LMS
/???
frontend-app-learning
/course/{course_id}/dates
N/A
Status | ||
---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Course Home: Outline
`LMS
/???
frontend-app-learning
/course/{course_id}/home
N/A
Status | ||
---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Course Home: Progress
LMS
/courses/{course_id}/progress
frontend-app-learning
/course/{course_id}/progress
course_home_mfe.course_home_mfe_progress_tab
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
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
/courses/{course_id}/{customtab_block_id}
frontend-app-learning
/course/{course_id}/{tabs}/{customtab_block_id}
TBD
Status | ||
---|---|---|
|
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 help wanted
label.
Courseware: Sequence
LMS
/???
frontend-app-learning
/???
N/A
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Legacy is partially removed. Full removal is blocked by studio course preview, which doesn’t yet work in learning mfe.
Courseware: render_xblock
LMS
/xblock/{usage_key}
LMS
/xblock/{usage_key}
N/A
Status | ||
---|---|---|
|
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
(called by Python, not accessed directly by URLs)
xblocks-contrib
(called by Python, not accessed directly by URLs)
xmodule.use_extracted_block.{block_tag}
Status | ||||
---|---|---|---|---|
|
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)
/???
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
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
/course/{course-key}/home?q=search-term
courseware.mfe_courseware_search
NEED DISCOVERY: is this at parity? is it live for edx.org, open edx?
Program Dashboard
LMS
/dashboard/programs
TBD
/TBD
Status | ||
---|---|---|
|
Course Certificates
LMS
/certificates/{cert_id}
TBD
/TBD
Status | ||
---|---|---|
|
Program Certificates
Credentials
/credentials/{cert_id}
TBD
/TBD
Status | ||
---|---|---|
|
Track Selection
LMS
/???
TBD
/TBD
course_modes.use_new_track_selection
?
NEEDS DISCOVERY: What is the status? Do we rewrite or DEPR?
Course Messaging
LMS
/???
TBD
/TBD
NEEDS DISCOVERY: What is the status?
Basket / Payment
Ecommerce
/???
frontend-app-order-history
/???
Status | ||||
---|---|---|---|---|
|
NEEDS DISCOVERY: Is replacement enabled in open edx? Is it at parity?
https://github.com/openedx/public-engineering/issues/8168LMS
Order HistoryProfile
Ecommerce
started: 2019-Jan
rolled out (mvp): 2019-Mar
completed (~parity): pending linking from header in Edge
LMS
/???
frontend-app-ecommerce
/???
Status | ||||
---|---|---|---|---|
|
NEEDS DISCOVERY: Is replacement enabled in open edx? Is it at parity?
started: 2019-Jan
rolled out (mvp): 2019-Mar
completed (~parity): pending linking from header in Edge
LMS?
ID Verification
started: 2020-Apr-16
rolled out (mvp): 2020-Jul-24
completed (~parity): 2020-Nov-1
removed old: hold
Jira Legacy | ||||||
---|---|---|---|---|---|---|
|
LMS
Course Home: Dates
started: 2020-Jun
rolled out (mvp): 2020-Oct
completed (~parity): 2021-May-15
removed old: Apr 2022
Status | ||||
---|---|---|---|---|
|
repo:https://github.com/edx/frontend-app-learning
LMS
Course Home: Outline
started: 2020-Aug
rolled out (mvp): 2021-Feb-9
completed (~parity): 2021-May-15
removed old: Apr 2022
Status | ||||
---|---|---|---|---|
|
repo:https://github.com/edx/frontend-app-learning
LMS
Course Home: Progress
started: 2021-Feb
rolled out (mvp): 2021-Sep-09 (with some exemptions on Prod)
completed (~parity)(Prod):
completed (~parity)(Edge): 2021-Sep-10
removed old:
Discussions
LMS
/???
/???
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
NEEDS DEPR
NEEDS DISCOVERY: Is this sufficiently at parity?
Learner Record
Credentials
/???
/TBD
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
Replacement:
Instructor Dashboard (all pages)
LMS
/???
frontend-app-gradebook (should be renamed to frontend-app-instruction, or something)
Status | ||
---|---|---|
|
Should subsume
Discover New Courses
LMS
/???
frontend-app-catalog?
/TBD
Status | ||
---|---|---|
|
Course About
LMS
/???
frontend-app-catalog?
/TBD
Status | ||
---|---|---|
|
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/
...
LMS
...
Courseware: Sequence & Unit
...
started: 2020-Jan
rolled out (mvp): 2020-Sep
completed (~parity)(Prod): 2021-Jun
completed (~parity)(Edge): 2022-Feb
removed old:
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/
...
...
LMS
...
Courseware: Proctored Exam
...
Status | ||||
---|---|---|---|---|
|
...
started: 2021-Mar
rolled out (mvp): 2021-Jul
completed (~parity): 2021-Jul
removed old: Hold
team: cosmonauts
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-
...
LMS
...
Courseware: Search
...
Status | ||
---|---|---|
|
...
LMS
...
Track Selection
...
Status | ||||
---|---|---|---|---|
|
...
LMS
...
Course Messaging
...
ecommerce
...
Basket / Payment
...
Status | ||||
---|---|---|---|---|
|
...
started: 2019-June
rolled out (mvp): 2019-Aug
completed (~parity): 2019-Sep
removed old:
...
https://github.com/openedx/public-engineering/issues/68
...
ecommerce
...
Order History
...
Status | ||||
---|---|---|---|---|
|
...
started: 2019-Apr
rolled out (mvp): 2019-Apr
completed (~parity): 2019-May
removed old:
...
https://github.com/openedx/public-engineering/issues/71
...
LMS
...
Discussions
...
Status | ||||
---|---|---|---|---|
|
...
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:
References
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