Add documentation on how to redirect when moving pages
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 17
- Forks
- 23
- Avg merge
- 4d 1h
- Merged PRs (30d)
- 8
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Read the Docs redirects guide and locate the repository's documentation entry point for contributor or review guidance. Document when and why redirects should be added when pages move, along with the relevant Read the Docs procedure. Done means reviewers can use the guidance to identify and address moved-page links.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100