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!f
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
| title |
| TBD |
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Preview | LMS-Preview
| 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? | Studio: Course Custom Pages | CMS
|
|
frontend-app-authoring
| TBD |
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course advanced settings | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Schedule & Details | CMS /settings/detailshttps://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
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course gradingadvanced settings | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course updatesSchedule & Details | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Importgrading | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Exportupdates | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Video UploadsImport | CMS
|
|
EXTRA CONFIG IN .env
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Files & UploadsExport | CMS
|
|
|
Should also be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Logged-in Home PageCourse Video Uploads | CMS
|
|
|
|
EXTRA CONFIG IN .env
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course content outline editorFiles & Uploads | CMS
|
|
|
As of May-2024: in Beta Testing on
Not live on edge.edx.org | Studio: Unit editor | CMS
|
| contentstore.
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
|
|
| Studio: Course Team
https://github.com/openedx/edx-platform/issues/35261
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course content outline editor | CMS
|
|
As of May-2024:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Textbooks Unit editor | CMS
|
|
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Group ConfigurationsTeam | CMS
|
|
|
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Page & ResourcesCourse Textbooks | CMS
|
|
|
|
| Studio: Text (HTML) Editor | CMS
| |||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Course Group Configurations | CMS
|
|
|
https://github.com/openedx/edx-platform/issues/34692
Should be part of 2Us DEPR around Studio Frontend MFE | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Page & Resources | CMS
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
colour | Red | title | needs improvementfrontend-app-course-authoring
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Video EditorText (HTML) Editor | CMS
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
colour | Green | title | parity achievedfrontend-app-course-authoring
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Library Authoring (all pages) | CMS
|
|
|
|
|
In development: Schema, OpenCraft, and Axim. (Slack: #content-libraries-relaunch-dev)
| Course Dashboard aka Learner Dashboard aka Learner Home | LMS
| ` | |||||||||||||||||||||||||||||||||||||||||||||||
Studio: Video Editor |
|
|
|
[BD-08] B2C Learner Dashboard MFE Conversion
https://github.com/openedx/edx-platform/issues/3532635257 Note: This is only the learner course dashboard. The learner programs dashboard does not have an MFE replacement yet. | Login/Registration | |||||||||||||||||||||||||||||||||||||||||||||||||||
LMSStudio: Library Authoring (all pages) | CMS
|
Status | | |||||||||||||||||||||||||||||||||||||||||||||||||||||
colour | Blue | title | Live on edx.orgIn Django settings:
|
https://github.com/openedx/public-engineering/issues/81 In development: Schema, OpenCraft, and Axim. (Slack: #content-libraries-relaunch-dev) https://github.com/openedx/edx-platform/blob/38320f8433427111c6cfb2bfaaa70aec5b989053/lms/templates/student_account/login_and_register.html MISSING FEATURE IN MFE: Custom registration fields.
| Profile | LMS | ||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Maintenance | CMS
| frontend-app-authoring ??? |
| Account Settings | LMS /
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Maintenance: Announcements | CMS
| frontend-app-authoring ??? |
| ID Verification | LMS /
| |||||||||||||||||||||||||||||||||||||||||||||||||||
Studio: Maintenance: Force Publish Course | CMS
| frontend-app-authoring ??? |
Unclear whether live in named release. Needs DEPR. | Course Home: Dates | LMS
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
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/publicedx-engineeringplatform/issues/5035326 | Course Home: Outline | LMS
|
| title | Legacy removed!Note: This is only the learner course dashboard. The learner programs dashboard does not have an MFE replacement yet.||||||||||||||||||||||||||||||||||||||||||||||||
Login/Registration | LMS
|
|
|
| Course Home: Progress | LMS
|
|
| ||||||||||||||||||||||||||||||||||||||||||||||||
colour | Green | title | parity achievedhttps://github.com/openedx/edx-platform/blob/38320f8433427111c6cfb2bfaaa70aec5b989053/lms/templates/student_account/login_and_register.html||||||||||||||||||||||||||||||||||||||||||||||||||||||
Profile | LMS
|
| ??? |
Needs a DEPR | Courseware: Sequence & Unit | LMS | ||||||||||||||||||||||||||||||||||||||||||||||||||
Account Settings | LMS
|
| ??? |
Legacy is partially removed. Full removal is blocked by studio course preview, which doesn’t work in learning mfe | Courseware: Built-in XBlock Views||||||||||||||||||||||||||||||||||||||||||||||||||||
ID Verification | LMS
|
|
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
|
| ||||||||||||||||||||||||||||||||||||||||||||||||||
colour | Red | title | needs improvementfrontend-app-?????? |
Unclear whether live in named release. Needs DEPR. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
Course Home: Dates | LMS
| frontend-app-learning
| N/A |
https://github.com/openedx/edxpublic-proctoringengineering/issues/122650 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. |
|
| ||||||||||||||||||||||||||||||||||||||||||||||||
Program Dashboard | LMS
|
| Course Certificates | LMS
|
| Program Certificates | Credentials
|
| Track Selection | LMS
|
| NEEDS DISCOVERY: What is the status? Do we rewrite or DEPR? | Course Messaging | LMS
| NEEDS DISCOVERY: What is the status? | Basket / Payment | Ecommerce
| Course Home: Outline | `LMS
| frontend-app-learning
| N/A |
| ||||||||||||||||||||||||||||||||||
Course Home: Progress | LMS
| frontend-app-learning
|
|
NEEDS DISCOVERY: Is replacement enabled in open edx? Is it at parity?
NEEDS DISCOVERY: Is replacement enabled in open edx? Is it at parity? | Order History | Ecommerce
|
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/
...
...
...
...
Discussions
...
LMS
/...?
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
NEEDS DEPR
NEEDS DISCOVERY: Is this sufficiently at parity?
...
[latest release / tutor master] https://github.com/
...
...
Learner Record
...
Credentials
/...?
Status | ||||
---|---|---|---|---|
|
Status | ||||
---|---|---|---|---|
|
...
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-
...
Instructor Dashboard (all pages)
...
LMS
/...?
Status | ||
---|---|---|
|
...
{APPNAME}
Example:
https://github.com/openedx/frontend-app-
...
Discover New Courses
...
LMS
/...?
...
Status | ||
---|---|---|
|
...
Course About
...
LMS
/...?
...
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/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
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