docs: added rtd redirects.yml file #427
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added the RTD redirects file which can be used with https://pypi.org/project/readthedocs-cli/ to manage bulk redirects in RTD. This file is not parsed by the RTD platform and won't affect any automated builds. It is useful to have this file in the repo because: - it provides a machine and human parseable reference for the canonical set of redirects we are using on the project - it can be used to manipulate the redirects more efficiently than in the web interface - given the above, it can be version controlled to provide some light-weight governance on the redirects used in the docs. It isn't considered normative content because it's not part of the Standard, but having it in the repo allows us to use PRs to manage it openly. - in the future, it can be used as part of the automated build process to sync redirects every time it is merged into the main branch. The file is quite heavily commented to provide inline documentation to support its use and explain the context of different redirects which are in place.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added the RTD redirects file which can be used with https://pypi.org/project/readthedocs-cli/ to manage bulk redirects in RTD.
This file is not parsed by the RTD platform and won't affect any automated builds (unless we specifically want it to as part of a github action)
It is useful to have this file in the repo because:
it provides a machine and human parseable reference for the canonical set of redirects we are using on the project
it can be used to manipulate the redirects more efficiently than in the web interface
given the above, it can be version controlled to provide some light-weight governance on the redirects used in the docs. It isn't considered normative content because it's not part of the Standard, but having it in the repo allows us to use PRs to manage it openly.
in the future, it can be used as part of the automated build process to sync redirects every time it is merged into the main branch.
The file is quite heavily commented to provide inline documentation to support its use and explain the context of different redirects which are in place.