-
Notifications
You must be signed in to change notification settings - Fork 933
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
Use a version-controlled file as source of truth for Read the Docs redirects #1408
Comments
If we decide that we want this, I think it makes sense to make this into a chunk of reusable code -- and, I'd like to have co-maintainer(s) on that code as well to avoid having a bus factor of 1 as well as avoiding the need to fix multiple places if any of the relevant platforms (GitHub Actions, RtD) evolve. 😅 |
Is it important to keep using RTD's HTTP redirects, as opposed to HTML redirects (that we can create with sphinx-reredirects or similar)? |
Let's discuss this in #1401, to avoid splitting the discussion. |
Oh, sorry, I had missed some of your comments there. |
There's also https://pypi.org/project/readthedocs-cli/ |
I'm working on this. @webknjaz @di @ewdurbin Could one of you please post a screenshot of the current redirects so that I can initialize the new file with them? They should be on https://readthedocs.org/dashboard/python-packaging-user-guide/redirects/ |
(Or you could add @pradyunsg as maintainer on RTD, since he seems interested in this...) |
|
That was quick, thank you! |
Invited Pradyun on RTD. He should have access regardless... |
I did some experiments, and unfortunately, I hit a bug in RTD that's going to complicate our lives here: readthedocs/readthedocs.org#10963. There is some problem that I don't yet fully understand, where RTD is sensitive to the order between redirects, with earlier redirects trumping later ones. |
The idea is basically the same as that of pypa/pip#11652.
The proposal is that we adopt the same here. This serves to move the ability to add redirects to everyone with the ability to commit to this repository, and makes it possible to ensure that the actually-configured redirects are more generally visibke/accessible.
The details of how it'd work are in the commit messages in the aforementioned PR.
The text was updated successfully, but these errors were encountered: