openedx / openedx/docs.openedx.org
setup named releases for Technical Reference in RTD
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 35
- Forks
- 95
- Avg merge
- 5d 15h
- Merged PRs (30d)
- 3
Description
As an open edX operator, I'd like a reliable source of information about toggles and settings that apply to the named release that I am deploying.
As the release notes writer, I'd like an easy way to be able to diff releases of the technical reference, so I can quickly build lists of new and removed settings for the release notes.
@pdpinch, Read The Docs allows setting multiple versions that are built. We could even add public versions for tagged releases. This way, users will be able to switch between them with the panel in the bottom right corner of the page. Example page, RTD config:
Originally posted by @Agrendalath in https://github.com/openedx/build-test-release-wg/issues/133#issuecomment-1092914446
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
Start with the linked Read the Docs versions page and the referenced RTD configuration example. Inspect this repository's documentation build and release setup to determine how tagged Technical Reference versions are exposed. Done means named releases are built and publicly selectable in RTD, allowing operators to view a release and writers to compare versions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100