...
In RTD, versions for an Open edX release are created from a protected GitHub branch. After the release-name branch is built, you can find a corresponding version in RTD on the Versions page, in the long list of inactive versions. Find the release-name branch version, click Edit, and select Active.
- We should consider the release version frozen and only update it separately from master in extreme circumstances.
- Ned and Alison found that it makes sense to specify the RTD version as the GitHub branch, and make any necessary doc changes to a PR on the release-name.rc branch.
- There is a (slow) automated process on RTD that updates the list of versions that you can make available for a project (Admin > Versions). Ned had to force this list to update by making "nedbump" PRs.
...
- Open edX Release Notes
- Built off of master branch; uses latest project in RTD.
- Each version is cumulative.
- Installing, Configuring, and Running the edX Platform
- Built off of release-name branch; uses release-name version in RTD.
- For the Dogwood release, an RTD limitation required a shorter URL length. The Open edX ICR project, built from the named-release-dogwood.rc version, is the Dogwood version. RTD reports that this issue has been resolved, but we have not tested as of 25-Feb-2016.
- Building and Running an Open edX Course
- Built off of release-name branch; uses release-name version in RTD.
- For the Dogwood release, an RTD limitation required a shorter URL length. The Open edX CA project, built from the named-release-dogwood.rc version, is the Dogwood version. RTD reports that this issue has been resolved, but we have not tested as of 25-Feb-2016
- Open edX Learner's Guide
- Built off of release-name branch; uses release-name version in RTD.
- Platform API guide
- Built off of release-name branch in edx-platform; uses release-name version in RTD.
For reference, the following guides for the Open edX community are not release-specific. They are always built off of master branch and use latest project in RTD.
...
- docs.edx.org
- Studio online help
- Currently Studio online help for all users links to Partner course staff documentation.
- We will change online help configuration to:
- By default point to the latest Open edX documentation.
- Modify the configuration in release branches to point to the release-specific version of documentation.
- Work with Devops to enable changing configuration in edx.org and Edge deployments to point to Partner documentation.
- LMS online help (two links from the Instructor Dashboard) - leads to Zendesk Help Center
- Search Engines
- As we support more versions of documentation, search engines can return multiple versions of the same content.
- We will update titles and chrome around documents to make the audience and version more clear.
...