openedx / openedx/openedx-platform
Make Docs Links Configurable
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8.2k
- Forks
- 4.4k
- Avg merge
- 6d 18h
- Merged PRs (30d)
- 42
Description
Currently, documentation links are hardcoded to docs.openedx.org. Operators who may use different versions of documentation, on ReadTheDocs or not, may wish to override some of these links to point at internal documentation or tutorials for their users.
This would involve having a dictionary of some sort in site settings override files that allow you to map a given URL to one of your own choosing.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No files or tests are named in the issue. Start by locating the hardcoded docs.openedx.org links and the site settings override mechanism, then determine which links should be configurable; done means selected documentation URLs can be overridden without changing code.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100