Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

setup named releases for Technical Reference in RTD #357

Open
pdpinch opened this issue May 29, 2022 · 3 comments
Open

setup named releases for Technical Reference in RTD #357

pdpinch opened this issue May 29, 2022 · 3 comments

Comments

@pdpinch
Copy link
Contributor

pdpinch commented May 29, 2022

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

Originally posted by @Agrendalath in openedx/wg-build-test-release#133 (comment)

@NeOneSoft
Copy link

Hi @pdpinch!!!! May be this can be closed too If you are agree

@arbrandes
Copy link
Contributor

Closing as stale.

@arbrandes arbrandes transferred this issue from openedx/wg-build-test-release Jul 19, 2023
@arbrandes arbrandes moved this from Done to Backlog in Build-Test-Release Working Group Jul 19, 2023
@arbrandes
Copy link
Contributor

Reopening, now in the docs repo where it might get the proper attention.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Backlog
Development

No branches or pull requests

3 participants