-
Notifications
You must be signed in to change notification settings - Fork 42
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 docs migration warning and redirects from old pages #949
Add docs migration warning and redirects from old pages #949
Conversation
Hey @mdellweg, I would like some general feedback on this approach before undrafting. |
docs/index.md
Outdated
The documentation for pulp-cli and pulp-glue has moved to a new place. | ||
|
||
Learn more about the new documentation project [here](https://discourse.pulpproject.org/t/unified-documentation-part-2/1188/2) or go to the new site: | ||
|
||
- [pulp-cli section](https://staging-docs.pulpproject.org/pulp-cli/docs/user/) | ||
- [pulp-glue section](https://staging-docs.pulpproject.org/pulp-glue/docs/dev/learn/architecture/) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good in general.
I'd point the users to the new location first and then provide a link to the why however.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mean, move the user directly to staging-docs (like here) and edit the page there to contain the migration note?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, i just meant to shuffle the lines in this file around.
Whoever got here wants to know where it's now. Only a tiny portion of visitors may be interested in the why. So move the important links to the top.
e0becd6
to
f6ec09a
Compare
I'm not sure how this will get published, but it will be required install |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I take it you have tested this... XD
Not a very robust test, but yes, I tried accessing some of the old links and they got redirected. |
See pulp/pulp-docs#33
This adds a single page to the old documentation site with a note to the docs migration. Other pages are redirected to this, so people can understand what is going on before going to the new site.
The idea is that this gets published and stays freezed until July, when we should "deactivate" all legacy docs and add broad-redirects to the production site (under pulpproject.org)
Closes #932
Review Checklist: