Enable managing RTD redirects in-tree #11652
Merged
Conversation
This file contains 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
pradyunsg
added
the
type: maintenance
pradyunsg
added
the
skip news
pradyunsg
force-pushed
the
rtd-redirects
branch
from
a186f60 to
e68f016
Compare
pradyunsg
force-pushed
the
rtd-redirects
branch
from
e68f016 to
7a2290d
Compare
This is designed as a script and a data file (in YAML format), and meant to manage the RTD redirects with a version controlled file. This makes it possible for pull requests to this repository to update the redirects for this project's documentation (eg: for better error urls) and for this evolution to be tracked as a part of version control history.
This makes it possible for pip's documentation's redirects to be automatically synchronised with the `main` branch.
pradyunsg
force-pushed
the
rtd-redirects
branch
from
7a2290d to
8328135
Compare
uranusjr
reviewed
Dec 30, 2022
Comment on lines
+4
to
+11
| /dev/news-entry-failure: >- | ||
| https://pip.pypa.io/en/stable/development/contributing/#news-entries | ||
| /errors/resolution-impossible: >- | ||
| https://pip.pypa.io/en/latest/topics/dependency-resolution/#dealing-with-dependency-conflicts | ||
| /surveys/backtracking: >- | ||
| https://forms.gle/LkZP95S4CfqBAU1N6 | ||
| /warnings/backtracking: >- | ||
| https://pip.pypa.io/en/stable/topics/dependency-resolution/#possible-ways-to-reduce-backtracking |
There was a problem hiding this comment.
Is the stable/latest difference intended? I feel the /dev/ one should use latest, while the other two should use stable.
There was a problem hiding this comment.
Not really. I want us to fix these issues, but I wanted to do it separately from moving the source of truth into the repository source tree; to make sure that we make changes in a separate step from the migration to this.
|
I'm gonna merge this, but please holler if there's any concerns around this. :) |
|
Womp Womp. The one piece that I can't test locally failed (CI config). |
|
https://github.com/pypa/pip/actions/runs/3818209726/jobs/6494960476 has the first successful run. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This is designed as a script and a data file (in YAML format), and meant
to manage the RTD redirects with a version controlled file.
This makes it possible for pull requests to this repository to update
the redirects for this project's documentation (eg: for better error
urls) and for this evolution to be tracked as a part of version control
history.