-
Notifications
You must be signed in to change notification settings - Fork 4.3k
[DEPR]: Drop ENABLE_MKTG_SITE flag and legacy static templates #37053
Copy link
Copy link
Open
Labels
deprProposal for deprecation & removal per OEP-21Proposal for deprecation & removal per OEP-21
Description
RFC Start Date
2025-07-22
Target Plan Accepted Date
2025-08-05
Target Transition Unblocked Date
Replacement Already Available - 2025-07
Earliest Breaking Changes Unblocked Date
2025-12
Earliest Open edX Named Release with Breaking Changes
Verawood - 2026-04
Rationale
We currently have two ways of overriding some historic static content, one of which relies on using the legacy comprehensive theming. This is no longer the preferred way to do it and an alternative way to mange this is already in place via MKTG_URLs lets you provide any valid URLs for setting these values in legacy headers.
Removal
- The
ENABLE_MKTG_SITEflag will be removed and we will retain the code as if this flag is set to true. - The
MKTG_URL_LINK_MAPwill be removed. UseMKTG_URLSinstead. - The following static templates will be removed:
- lms/templates/static_templates/news.html
- lms/templates/static_templates/privacy.html
- lms/templates/static_templates/about.html
- lms/templates/static_templates/jobs.html
- lms/templates/static_templates/media-kit.html
- lms/templates/static_templates/faq.html
- lms/templates/static_templates/blog.html
- lms/templates/static_templates/donate.html
- lms/templates/static_templates/help.html
- lms/templates/static_templates/press.html
- lms/templates/static_templates/honor.html
- lms/templates/static_templates/contact.html
- lms/templates/static_templates/tos.html
- lms/templates/static_templates/sitemap.xml
- URL and view functions pointing to these templates will be removed.
Replacement
Moving forward the MKTG_URLS setting should be used for providing this information.
Your settings should look something like this to transition today:
ENABLE_MKTG_SITE = True
MKTG_URLS = {
'ABOUT': '/about-us',
'CONTACT': '/contact-us',
'FAQ': '/student-faq',
'COURSES': '/courses',
'ROOT': 'https://www.edx.org',
'TOS': '/edx-terms-service',
'HONOR': '/terms',
'PRIVACY': '/edx-privacy-policy',
'WHAT_IS_VERIFIED_CERT': '/verified-certificate',
}
MKTG_URL_LINK_MAP = {}
After Ulmo is cut, the ENABLE_MKTG_SITE setting and the MKTG_URL_LINK_MAP setting will no longer exist and can be removed from your config.
Deprecation
No response
Additional Info
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
deprProposal for deprecation & removal per OEP-21Proposal for deprecation & removal per OEP-21
Type
Projects
Status
Breaking Changes Unblocked