Skip to content

Best Practices Question: redirects for non-existent docs #4948

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

Closed
Nick-Harvey opened this issue Dec 3, 2018 · 4 comments
Closed

Best Practices Question: redirects for non-existent docs #4948

Nick-Harvey opened this issue Dec 3, 2018 · 4 comments
Labels
Needed: documentation Documentation is required Status: stale Issue will be considered inactive soon

Comments

@Nick-Harvey
Copy link

Details

Overall, I'd like to find out what's the best way to handle redirects for docs that get deleted. Here's the situation

We have old docs (v1.2.1 and we're now on 1.7.11) that are still being indexed by Google that are showing up pretty high in search results. Version 1.2.1 has been retired for a long time now and is set to an inactive version in RTD. Also, there are documents that since 1.2.1 have been deleted that users are still finding via search. When going to that page they get the banner saying that the version is old and that they should go do the latest. But since that doc doesn't exist in the latest version of the docs the link in the note won't work and users get the Maze page. So I guess my question(s) are as follows

  1. Is there a way to do a version wide redirect, possibly to a page that says these are outdated docs please go to xyz (which is a link to root of latest)
  2. Whats the best way of handling the deletion of docs and redirects.
  3. Is there a way to create a build notification that contains a list of broken links so we can resolve them.
  4. What's the best process for retiring old versions completely.

More context of what I'm talking about is in a github issue here: pachyderm/pachyderm#3224

Expected Result

A description of what you wanted to happen

Actual Result

A description of what actually happened

@stsewd
Copy link
Member

stsewd commented Dec 5, 2018

Have you read this https://docs.readthedocs.io/en/latest/user-defined-redirects.html? I think there are some use cases there, not sure if that covers all your questions,

@stsewd stsewd added the Needed: documentation Documentation is required label Dec 5, 2018
@Nick-Harvey
Copy link
Author

Thanks for chiming in :). We are using the user-defined-redirects but as I'm sure you can imagine that at scale, it gets unruly fast. One idea for a solution that comes to mind, is to have a customizable redirect page. That way when a user finds old documentation via search, instead of maze page or old docs, they get a page that can say whatever and include the correct links.

@stsewd
Copy link
Member

stsewd commented Dec 6, 2018

is to have a customizable redirect page

Do you mean like a custom 404 page? we have #353 and #2551

@stale
Copy link

stale bot commented Jan 20, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Jan 20, 2019
@stale stale bot closed this as completed Jan 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required Status: stale Issue will be considered inactive soon
Projects
None yet
Development

No branches or pull requests

2 participants