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

Redirect previous roadmap location to current one #90

Closed

Conversation

davidhorstmann-arm
Copy link
Contributor

The document roadmap.md was linked-to several times then moved as part of restructuring work. In order to retain the working link, add the sphinx-reredirects module and tell it to redirect the old roadmap.md location to the new one.

This allows us to refactor the documentation while redirecting old
paths to the new location so that documentation links remain valid.

See the documentation of sphinx-reredirects at:

https://documatt.gitlab.io/sphinx-reredirects/index.html

Signed-off-by: David Horstmann <[email protected]>
@davidhorstmann-arm
Copy link
Contributor Author

Note for reviewers: The result on this PR's build of the docs is that the old location:
https://mbed-tls--90.org.readthedocs.build/en/90/roadmap/
Is redirected to the new location:
https://mbed-tls--90.org.readthedocs.build/en/90/project/roadmap/

@bensze01
Copy link
Contributor

bensze01 commented Apr 14, 2023

So far I've been adding redirects to the readthedocs config - which produces HTTP 301 moved redirects rather than HTML <meta> redirects like sphinx-reredirects. The downside is that the list of redirects lives outside this repo, but it is more compatible with non-browser clients.

@bensze01
Copy link
Contributor

@bensze01
Copy link
Contributor

FYI: Readthedocs feature request for managing redirects in-tree, with potential workarounds listed: readthedocs/readthedocs.org#4221

@davidhorstmann-arm
Copy link
Contributor Author

So far I've been adding redirects to the readthedocs config - which produces HTTP 301 moved redirects rather than HTML <meta> redirects like sphinx-reredirects. The downside is that the list of redirects lives outside this repo, but it is more compatible with non-browser clients.

Ah okay, that makes more sense then. I'll close this PR as superfluous.

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

Successfully merging this pull request may close these issues.

2 participants