docs: scylla-4.18.1.x documentation fixes #546
Merged
Conversation
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
Bouncheck
force-pushed
the
scylla-4.18.1.x
branch
5 times, most recently
from
5dc7fb1 to
0f016f0
Compare
dkropachev
approved these changes
May 29, 2025
|
It looks like branch |
Author
|
I'll recreate it from 4.18.1.0 tag |
Currently the previews built using `{eval-rst}` and myst_parser look to be
more broken than switching back to `eval_rst` directive and adding the version
to the list of branches using recommonmark.
Specifically what seems to be pretty important and does not work with myst
are relative links found in text like word 'integration' linking to
` http://localhost:5500/scylla-4.18.1.x/manual/core/index.html#integration/ `
This link should not treat `integration` as an anchor but as a subpage.
This change makes the `make preview` and `make test` fail as it seems those
targets try to use myst which does not understand `eval_rst` and only in
`multiversion` those sections are understood by lexer correctly.
Those links redirect to internal API which is not a part of the generated javadoc, leading to 404 on visit. Instead redirect to code on github.
When generating documentation website pages move also generated javadoc for query-builder and mapper-runtime modules. Some links in manuals attempt to link to the javadoc for those modules and end up being broken without those javadocs included.
Bouncheck
force-pushed
the
scylla-4.18.1.x
branch
from
ef43e74 to
8cc9aec
Compare
Bouncheck
force-pushed
the
scylla-4.18.1.x
branch
from
0f016f0 to
e8ca351
Compare
Author
|
@dkropachev is it correct now? |
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.
Collection of fixes for scylla-4.18.1.x branch. See respective commit descriptions for details.