-
Notifications
You must be signed in to change notification settings - Fork 683
Fix broken docs caused by incorrect feature-scroll
usage in Antora
#3262
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
Closed
dmitrysulman
wants to merge
1
commit into
spring-projects:main
from
dmitrysulman:fix-antora-feature-scroll-attribute
Closed
Fix broken docs caused by incorrect feature-scroll
usage in Antora
#3262
dmitrysulman
wants to merge
1
commit into
spring-projects:main
from
dmitrysulman:fix-antora-feature-scroll-attribute
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
Signed-off-by: Dmitry Sulman <[email protected]>
Overriding this attribute for a specific |
Thank you for your contribution. That's merged, polished, and backported now. In query-method-details, we rather want to keep opt-in as the majority of modules doesn't support scrolling (window) queries. |
mp911de
pushed a commit
that referenced
this pull request
May 9, 2025
Signed-off-by: Dmitry Sulman <[email protected]> Closes #3262
mp911de
added a commit
that referenced
this pull request
May 9, 2025
Use dynamic copyright year. Disable feature-scroll by default on query method details to let modules opt-in. See #3262
mp911de
pushed a commit
that referenced
this pull request
May 9, 2025
Signed-off-by: Dmitry Sulman <[email protected]> Closes #3262
mp911de
added a commit
that referenced
this pull request
May 9, 2025
Use dynamic copyright year. Disable feature-scroll by default on query method details to let modules opt-in. See #3262
mp911de
pushed a commit
that referenced
this pull request
May 9, 2025
Signed-off-by: Dmitry Sulman <[email protected]> Closes #3262
mp911de
added a commit
that referenced
this pull request
May 9, 2025
Use dynamic copyright year. Disable feature-scroll by default on query method details to let modules opt-in. See #3262
mp911de
added a commit
that referenced
this pull request
May 9, 2025
Add missing Antora property. See #3262
mp911de
added a commit
that referenced
this pull request
May 9, 2025
Add missing Antora property. See #3262
mp911de
added a commit
that referenced
this pull request
May 9, 2025
Add missing Antora property. See #3262
mp911de
pushed a commit
that referenced
this pull request
May 9, 2025
Signed-off-by: Dmitry Sulman <[email protected]> Closes #3262
mp911de
added a commit
that referenced
this pull request
May 9, 2025
Use dynamic copyright year. Disable feature-scroll by default on query method details to let modules opt-in. See #3262
mp911de
added a commit
that referenced
this pull request
May 9, 2025
Add missing Antora property. See #3262
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There are a couple of issues with the
feature-scroll
attribute in the Antora docs:endif::[]
for the Offset-based Window table row is placed incorrectly:spring-data-commons/src/main/antora/modules/ROOT/pages/repositories/query-methods-details.adoc
Lines 455 to 464 in f4e9581
This causes the table to break when
feature-scroll
is not set::feature-scroll: true
in index.adoc has no effect because attributes set on one page are not visible to other pages. Additionally, setting the attribute value totrue
is redundant —ifdef
blocks are evaluated based on whether the attribute is defined, regardless of its value (source).As a result, Scroll API-related content is always hidden in the documentation.
This PR fixes the above by explicitly defining the
:feature-scroll:
attribute in the two pages where it's used: