[DEPR]: Studio course page templates and javascript

[KristinAoki]

Proposal Date

2025-01-14

Target Ticket Acceptance Date

2025-01-28

Earliest Open edX Named Release Without This Functionality

Teak - 2025-04

Rationale

This technology should be removed because it is fully replaced by the authoring MFE. Keeping the html files and rendering code for the legacy pages increases code debt as it will obsolete.

Removal

General removal

• cms/djangoapps/contentstore/toggles.py, delete lines 238-554
• cms/djangoapps/contentstore/rest_api/v1/serializers/course_waffle_flags.py
• cms/djangoapps/contentstore/rest_api/v1/views/course_waffle_flags.py
• cms/djangoapps/contentstore/rest_api/v1/views/tests/test_course_waffle_flags.py
• cms/djangoapps/contentstore/utils.py, delete lines 290-429 and 444-506

Page specific removal

*For each of the pages' html files, the imported js factory should also be deleted

Course home

• cms/djangoapps/contentstore/views/course.py, delete line 660 and 662-664
• course-create-rerun.html
• index.html

Course outline

• cms/djangoapps/contentstore/views/course.py, delete line 743 and 745-753
• course_outline.html
• structured_tags_block.html

Unit page

• cms/djangoapps.contentstore/views/component.py, update line 154 to

if is_unit_page:

Course updates

• cms/djangoapps/contentstore/contentstore/views/course.py`, delete line 1084 and 1086-1097
• course_info.html

Course pages

• cms/djangoapps/contentstore/rest_api/v0/views/tabs.py, delete lines 82-83, 90, and 99
• cms/djangoapps/contentstore/views/tabs.py, delete line 68 and 70-81
• cms/djangoapps/contentstore/views/course.py, delete line 1477 and 1479-1480
• edit-tabs.html
• textbooks.html

Course assets and files

• cms/djangoapps/contentstore/asset_storage_handlers.py, delete lines 174-176 and 178-186
• asset_index.html

Course videos

• cms/djangoapps/contentstore/video_storage_handlers.py, delete lines 742 and 744-748
• videos_index.html
• videos_index_pagination.html

Schedule and details

• cms/djangoapps/contentstore/contentstore/views/course.py, delete line 1172 and 1174-1175
• settings.html

Grading

• [cms/djangoapps/contentstore/views/course.py, delete line 1215 and 1217-1218
• settings_graders.html

Course team

• cms/djangoapps/contentstore/views/user.py, delete line 61 and 63
• manage_users.html

Group configurations

• cms/djangoapps/contentstore/views/course.py, delete line 1644 and 1646-1647
• group_configurations.html

Advanced Settings

• cms/djangoapps/contentstore/views/course.py, delete line 1312 and 1314-1329
• setttings_advanced.html

Certificates

• cms/djangoapps/contentstore/views/certificates.py, delete line 397 and 399-400
• certificates.html

Import

• cms/djangoapps.contentstore/views/import_export.py, update line 100 to

if not library:

Export

• cms/djangoapps.contentstore/views/import_export.py, update line 349 to

if not library:

Checklist

• checklist.html

Accessibility

• accesibility.html

Replacement

All of the removed html code will be replaced by code in the frontend-app-authoring repo. Below is a page by page breakdown with their primary code folder

• Course home
• Course outline
• Unit/container page
• Course updates
• Course pages
• Course assets and files
• Course videos
• Schedule and details
• Grading
• Group configurations
• Course team
  
• Advanced Settings
• Certificates
• Import
• Export
• Checklist
• Accessibility

There are additional folders inside frontend-app-learning that are being used as replacements.

Deprecation

No response

Migration

No response

Additional Info

Additional clean up will be needed when v2 libraries are fully rolled out. Currently import.hmtl, export.html, and container.html are used for libraries.

Task List

Course home

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Course outline

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Unit/container page

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Course updates

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Course pages

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Course assets and files

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Course videos

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Schedule and details

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Grading

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Course team

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Group configurations

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Advanced Settings

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Certificates

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Import

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Export

• Remove waffle flag
• Replace waffle flag dependent redirect with redirect as default
• Remove associated html file
• Remove associated js factories

Checklist

• Remove associated html file
• Remove associated js factories

Accessibility

• Remove associated html file
• Remove associated js factories

[kdmccormick]

Fantastic! Thank you for making this and for enumerating all the parts of it.

The React Unit editor is still in the progress, so I propose that we take it out of the scope of this deprecation, and use this ticket to track it separately:

• [DEPR]: Legacy Unit Editor #35261

Tangentially, for anyone else reading this ticket: please be aware that we have separate deprecation tickets to track the removal of the legacy component editors:

• [DEPR]: Legacy Text Editor #34692
• [DEPR]: Legacy Problem Editor #35256
• [DEPR]: Legacy Video Editor #35257