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

Add documentation on how to redirect when moving pages #699

Open
MKKnorr opened this issue Mar 21, 2024 · 0 comments
Open

Add documentation on how to redirect when moving pages #699

MKKnorr opened this issue Mar 21, 2024 · 0 comments

Comments

@MKKnorr
Copy link
Contributor

MKKnorr commented Mar 21, 2024

It is a quite common occurence, that links break because pages have been moved, but no redirects added.
It should be common practice, to also add redirects when moving pages.

It seems that this mostly happens, because people are not aware of how to do this. Another reason might of course be, that not everyone has access to those settings in readthedocs.

Documenting this and providing guidelines at least creates awareness for this problem, and should help reviewers pay attention to creating the redirects before/when merging PRs that move pages.

The technical documentation for how to create redirects in readthedocs is available here: https://docs.readthedocs.io/en/stable/guides/redirects.html

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

No branches or pull requests

1 participant