Skip to content

fix: repoint three dead links - #1515

Open
rawsun007 wants to merge 2 commits into
openedx:mainfrom
rawsun007:fix-dead-links
Open

fix: repoint three dead links#1515
rawsun007 wants to merge 2 commits into
openedx:mainfrom
rawsun007:fix-dead-links

Conversation

@rawsun007

@rawsun007 rawsun007 commented Sep 2, 2026

Copy link
Copy Markdown

Found by requesting every URL under source/ — 2,025 unique links — and keeping only the dead ones with a target I could verify.

caliper_events.rst and xapi_events.rst both link event-routing-backends/blob/master/docs/event-mapping/Supported_events.rst for the list of supported events. That file 404s; it now lives at docs/technical_documentation/concepts/event-mapping/supported_events.rst (new directory, lowercased filename), which exists on master at 42 KB. These are the "supported Caliper events" and "supported xAPI events" targets, so the reference pages for both event formats currently dead-end.

community/release_notes/quince.rst links github.com/openedx/edxplatform for CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATE. There is no such repository — the hyphen is missing. The pinned commit d3d203c and the path xmodule/course_block.py are both valid under openedx/edx-platform, so only the repo name changed.

Dead, but I did not guess at a replacement

  • educators/references/course_development/files_page.rst links docs.openedx.org/en/latest/educators/how-tos/manage_files.html from a seealso. No manage_files page exists anywhere in source/, so I do not know whether it was renamed or never written. The :ref:Add Course Files`` line above it still resolves.
  • developers/references/developer_guide/extending_platform/xblocks.rst links edx-platform/blob/master/xmodule/progress.py for the Progress class. That file is gone from master and I could not find where the class moved.
  • site_ops/concepts/user_retirement.rst links user-retirement-guide.readthedocs.io, which no longer resolves.
  • Several openedx/configuration playbook links 404, and frontend-template-application/tree/frontend-base is a branch that no longer exists.
  • One link in xblocks-adjacent docs points into a .venv/lib/python3.11/site-packages/ path inside a pinned edx-platform commit, which cannot exist in the repository tree.

Happy to follow up on any of those if you tell me what they should point at.

The docs.openedx.org/projects/... URLs that a naive sweep flags are intersphinx bases built from f-strings in conf.py and a <repo_name> template in get-your-project-docs-on-rtd.rst, not broken links, so I left them alone.

AI disclosure

This was done with AI assistance: Claude (Opus), via Claude Code. It ran the sweep, resolved the replacements and drafted this description; I reviewed the diff. Every claim above was verified through the GitHub contents API rather than the HTML pages, because github.com rate-limited the bulk sweep and a 429 reads exactly like a 404 — one candidate looked dead for that reason and was not.

Context (per the review checklist)

  • Product review: not needed. This repairs three URLs in documentation prose. It changes no user-facing behaviour and is not related to roadmap work, so it takes the "no" branch at the first decision in the review flow.
  • Dependencies / blockers / timeline: none. Each of the three links is independent, and nothing else needs to land first.
  • Partner information: none, this is not for a specific site or course.
  • Supporting documentation: the replacement paths are verified in the PR description above; cask_renames-style evidence for the moved file is docs/technical_documentation/concepts/event-mapping/supported_events.rst existing on event-routing-backends@master.
  • CLA: the check is red. The Individual Contributor Agreement is mine to sign as the author, and I am doing that separately; I will comment here once it has been processed rather than assert it early.

- caliper_events.rst and xapi_events.rst pointed at
  docs/event-mapping/Supported_events.rst in event-routing-backends. That file
  moved to docs/technical_documentation/concepts/event-mapping/supported_events.rst
  and the old path 404s.
- quince.rst linked github.com/openedx/edxplatform, which is not a repository.
  The pinned commit and path are valid under openedx/edx-platform.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 2, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @rawsun007!

This repository is currently maintained by @openedx/wg-maintenance-docs.openedx.org.

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 approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To 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:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where 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:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@sarina sarina left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the submission! Just one change since we changed our main repo to https://github.com/openedx/openedx-platform last year.

New Waffle Flags:

* `CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATE <https://github.com/openedx/edxplatform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/xmodule/course_block.py#L61>`__
* `CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATE <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/xmodule/course_block.py#L61>`__

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATE <https://github.com/openedx/edx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/xmodule/course_block.py#L61>`__
* `CREATE_COURSE_WITH_DEFAULT_ENROLLMENT_START_DATE <https://github.com/openedx/openedx-platform/blob/d3d203cbac609adf23a6a8f003731fef12bd1ea1/xmodule/course_block.py#L61>`__

@sarina sarina moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Sep 2, 2026
@mphilbrick211

Copy link
Copy Markdown

Hi @rawsun007! Please let us know if you have any questions regarding submitting a CLA form. Thanks!

@rawsun007

Copy link
Copy Markdown
Author

The Individual Contributor Agreement has been signed and submitted. Flagging so the openedx/cla check can be re-run.

Everything else on this PR is green: the Read the Docs build passes, and the change is three URL replacements in documentation prose with no product-review implications.

@sarina

sarina commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

@rawsun007 - the CLA may take a few days to process. In the meantime, kindly address my review comment. Thank you

Per review: the main repository was renamed to openedx/openedx-platform last
year. The pinned commit and path resolve there; the old name only worked
through GitHub's rename redirect.
@rawsun007

Copy link
Copy Markdown
Author

Done in 7de1731 — the link now uses openedx/openedx-platform. Thanks for catching it; I had only checked that the URL resolved, and openedx/edx-platform does resolve, but through GitHub's rename redirect rather than as the canonical name. I confirmed xmodule/course_block.py exists at the same pinned commit d3d203c under the new name.

Understood on the CLA taking a few days — nothing needed from you there, I will leave it to process.

@sarina sarina left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@feanil can you keep an eye on this and merge when the CLA check passes?

@rawsun007

Copy link
Copy Markdown
Author

The CLA is signed and submitted (Axim Individual CLA via Docusign, today). Flagging so the openedx/cla check can be re-run once it has been processed on your side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Tests Run or CLA Signed

Development

Successfully merging this pull request may close these issues.

4 participants