-
Notifications
You must be signed in to change notification settings - Fork 38
docs: fix md redirections for multiversion support #531
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
base: scylla-4.x
Are you sure you want to change the base?
Conversation
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 have tried multiversionpreview limited to 2 last branches and I cannot get it to work. I still get redirected to main page for a version.
Here's what i did, similarly to as instructed in other PR:
- Made local
scylla-4.15.0.x
andscylla-4.14.1.x
branches and also pushed them to my own remote with applied identical change to source_suffix as in PR. - Returned to local branch with this PR checked out.
- Edited
BRANCHES
to contain only those two versions, editedsmv_remote_whitelist
(on separate runs i tried the valuesNone
,""
,r'^myrepo$'
) - Ran
make multiversionpreview
in docs subdirectory.
No matter the configuration I'm getting redirected from (for example) http://127.0.0.1:5500/scylla-4.14.1.x/manual/api_conventions/index.html
to http://127.0.0.1:5500/stable/index.html
when changing version from dropdown menu (4.15.0.x is "stable" in this case)
Regarding the version list: I see that it's severely outdated. I'll try to sort it out separately. Should be as simple as pushing new .x branches and updating the list. |
Thanks @Bouncheck for sharing this. After some more testing, I can confirm that it will not fix the issue in versions using the deprecated recommonmark parser. This includes all versions listed in However, we should avoid defining versions released after this commit (24 July 2024) in |
I agree. Let's not fix this for old versions that use recommonmark.
@Bouncheck This is something that needs to be fixed. I'll open a separate issue to do that, and I'll add more explanation there. Next steps:
Redirections will be working for the new versions that are NOT listed with |
Related issue & explanation scylladb/scylladb#23957
This should allow navigation between versions without being redirected to the main index page:
Note: This fix will only apply to future versions unless backported. While backporting may not be worth the effort, it's important to be aware that the issue will remain in older versions