Repository navigation
fix: point help-token documentation links at docs.openedx.org "latest" - #39154
uhlhosting wants to merge 3 commits into
Conversation
doc_version() returned "open-release-<line>.master" on named release branches, but docs.openedx.org does not publish versions under that slug (RTD serves "latest" and bare release names like "ulmo"). Every generated help link — including the "documentation" link in the Studio course-outline Section Highlights dialog — therefore 404s on release lines. Always return "latest" so the links resolve.
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
Thanks for the pull request, @uhlhosting! This repository is currently maintained by Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review. 🔘 Get product approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:
🔘 Submit a signed contributor agreement (CLA)
If you've signed an agreement in the past, you may need to re-sign. Once you've signed the CLA, please allow 1 business day for it to be processed. 🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere can I find more information?If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources: When can I expect my changes to be merged?Our goal is to get community contributions seen and reviewed as efficiently as possible. However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
|
Hi @uhlhosting! Welcome, and thank you for this contribution! In order for your CLA check to turn green, you'll need to submit a CLA form. If you are contributing as an individual, please fill out the individual CLA form here. If you are contributing on behalf of an organization, please have your manager reach out to oscm@axim.org so you may be added to your org's existing entity agreement. Please let me know if you have any questions. Thanks! |
|
@mphilbrick211 Hi, I have just submitted my form for approval. |
Hi @uhlhosting! Apologies for the delay as I was out of office last week. Are you contributing on behalf of UHL Hosting? If so, we'll need to do a different kind of agreement since you would not be contributing as an individual. Could you please clarify for us? That way we can make sure we get the right form over to you. Thanks! |
Hi @uhlhosting following up on my question above. Thanks! |
|
Hi @mphilbrick211 I am developing in behalf of UHL Hosting. How should we proceed? |
|
@uhlhosting thanks for confirming! I'm checking on this for you now. Will get back ASAP! |
|
@uhlhosting I've merged the upstream changes into your branch, please update any checkouts you have. |
Description
On named release branches (e.g.
release/verawood),openedx.core.release.doc_version()returnsopen-release-<line>.master, which is substituted into every help link viaHELP_TOKENS_VERSION(openedx/envs/common.py). Butdocs.openedx.orgdoes not publish versions under that slug — the Read the Docs project (docsopenedxorg) serveslatestand, at most, bare release names likeulmo.Result: every generated help link 404s on every named release. Example from a Verawood deployment — the "documentation" link inside Studio's Section Highlights dialog on the course outline points to:
Correct URL:
https://docs.openedx.org/en/latest/educators/how-tos/course_development/manage_course_highlight_emails.html(200).This change makes
doc_version()return"latest"unconditionally, so help links resolve on all release lines. It is a no-op onmaster(where it already returned"latest"); the value flows toHELP_TOKENS_VERSION(help-tokens resolution for CMS/LMS help links,get_help_urls()//api/contentstore/v1/help_urls) and to the MFE config instructor support URL (resolve_help_tokeninmfe_config_api).Impacted roles: Course Author (broken help links in Studio/MFEs), Learner (instructor-dashboard support link), Operator (reported broken links).
Supporting information
HELP_TOKENS_BOOKStodocs.openedx.org/en/latest(release notes), which is what makes the/latest→/open-release-verawood.mastersubstitution produce a dead URL on that branch.Testing instructions
.../en/open-release-<line>.master/...(404). After:.../en/latest/...(200).GET /api/contentstore/v1/help_urlsreturnsen/latestURLs for every token.doc_version()consumers derive expectations dynamically (mfe_config_apitests), nothing asserts the old slug format.Deadline
None — but a backport to
release/verawoodwould fix currently broken help links on the active release.Other information
RELEASE_LINE(RTD slugen/ulmodoes exist). Rejected becauseen/verawood(and future lines) isn't published yet, so links stay broken for a while after each release cut;latestalways resolves.