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

docs: fix missing redirects for api to reference/api #4429

Merged
merged 1 commit into from Apr 24, 2023

Conversation

consideRatio
Copy link
Member

@consideRatio consideRatio commented Apr 23, 2023

I saw a broken link in oauthenticators documentation:

image

@manics
Copy link
Member

manics commented Apr 23, 2023

Do our docs CI tests automatically check the destination of the redirects is valid, or is this something a reviewer should check?

@consideRatio
Copy link
Member Author

Do our docs CI tests automatically check the destination of the redirects is valid, or is this something a reviewer should check?

The rediraffe extension makes checks of redirects automatically during docs build, specifically that the new destination exist I think.

@minrk also developed a check in the test-docs workflow recently to help catch failure to setup redirects for files that were found to be relocated or similar, but apparently it didn't catch this. It would fail to detect something for example if a file was largely remade, then it could have been seen as a deleted file and an entirely new file instead.

I went ahead and manually tested for all redirects configured that:

  1. There was a page before at the redirect location: https://jupyterhub.readthedocs.io/en/3.0.0/api/.html was found
  2. There was a page we got redirected to after: https://jupyterhub--4429.org.readthedocs.build/en/4429/api/.html redirected correctly

@minrk minrk merged commit 8a074b1 into jupyterhub:main Apr 24, 2023
4 checks passed
@minrk
Copy link
Member

minrk commented Apr 24, 2023

Thanks! I wonder why the checkdiff didn't find these.

I believe rediraffecheckdiff does not validate targets (I introduced some typos while working on the redirect PR and it didn't complain, IIRC).

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

Successfully merging this pull request may close these issues.

None yet

3 participants