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 docs migration warning and redirects from old pages #949

Merged

Conversation

pedro-psb
Copy link
Member

@pedro-psb pedro-psb commented Apr 23, 2024

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:

  • An issue is properly linked. [feature and bugfix only]
  • Tests are present or not feasible.
  • Commits are split in a logical way (not historically).

@pedro-psb
Copy link
Member Author

Hey @mdellweg, I would like some general feedback on this approach before undrafting.

docs/index.md Outdated
Comment on lines 3 to 7
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/)
Copy link
Member

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.

Copy link
Member Author

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?

Copy link
Member

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.

@pedro-psb pedro-psb force-pushed the add-redirects-and-deprecation-warnings branch from e0becd6 to f6ec09a Compare April 25, 2024 16:50
@pedro-psb pedro-psb marked this pull request as ready for review April 25, 2024 16:51
@pedro-psb
Copy link
Member Author

I'm not sure how this will get published, but it will be required install mkdocs-redirects.

Copy link
Member

@mdellweg mdellweg left a 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

@mdellweg mdellweg merged commit 7f1fc56 into pulp:main Apr 26, 2024
21 checks passed
@pedro-psb
Copy link
Member Author

Not a very robust test, but yes, I tried accessing some of the old links and they got redirected.

@pedro-psb pedro-psb deleted the add-redirects-and-deprecation-warnings branch April 26, 2024 12:14
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

Successfully merging this pull request may close these issues.

Add redirects from old docs to new docs
2 participants