Better redirects support for multiversion#515
Merged
dgarcia360 merged 4 commits intoscylladb:masterfrom Jun 28, 2022
Merged
Conversation
Collaborator
|
@dgarcia360 Could you merge this PR so that we can see the result? |
Collaborator
Author
Collaborator
|
@dgarcia360 Yes, I can confirm that. Great! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #181
Motivation
Before, redirects were part of the theme. This means that, for every version, the same redirects were being created, giving us little control if we wanted to redirect a page from the previous version to a different URL.
Now, we are using a separate third-party package to create redirections. Instead of creating the same redirections for each version, we generate them at the end once the docs are built. This will allow us to have better control of the redirects per version.
How to test this PR
Once we merge this PR, https://sphinx-theme.scylladb.com/stable/test-redirect.html should redirect to https://sphinx-theme.scylladb.com/stable/index.html
Distributing this improvement
This change introduces breaking changes in the scylla/scylla-docs project. For this reason, I'm updating the minor version number so that the theme release does not propagate automatically.
Then, we'll submit a PR in the scylla-docs project that installs the new redirects extension as part of the publication process.