Skip to content

Fix documentation title sequence warnings#15337

Open
sanjana2505006 wants to merge 6 commits intoapache:7.0.xfrom
sanjana2505006:fix/docs-title-sequence
Open

Fix documentation title sequence warnings#15337
sanjana2505006 wants to merge 6 commits intoapache:7.0.xfrom
sanjana2505006:fix/docs-title-sequence

Conversation

@sanjana2505006
Copy link
Copy Markdown
Contributor

Fixes #14898.
I fixed the "section title out of sequence" warnings by adjusting the header levels in the .adoc files and using leveloffset in index.adoc to keep them consistent.

(Note: I couldn't find eventsAutoTimestamping.adoc in the repo, so I applied the fix to the other files that were throwing the same warning.)

Adjusts heading levels in included AsciiDoc files and uses leveloffset to resolve 'section title out of sequence' warnings.
@sanjana2505006
Copy link
Copy Markdown
Contributor Author

@jamesfredley Whenever you get a chance, please review and let me know if any changes are needed

Copy link
Copy Markdown
Contributor

@sbglasius sbglasius left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@sanjana2505006
Copy link
Copy Markdown
Contributor Author

@sbglasius Whenever you get a chance, please review and let me know if any changes are needed

@@ -44,27 +44,31 @@ public String getName() {
public String getSourcePath(String path, Language language) {
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes to this file don't appear to be material. We should revert them.

@jdaugherty
Copy link
Copy Markdown
Contributor

@sanjana2505006 can you please generate the single guide prior to your change & with this change? Then attach the results to this PR to assist in our review?

@bito-code-review
Copy link
Copy Markdown

The changes to TestFramework.java are purely cosmetic: they adjust line breaks for readability, remove an extra space, and convert a switch expression to a statement. These don't alter functionality, so reverting them is fine if the original style is preferred. No logic changes detected.

@sanjana2505006
Copy link
Copy Markdown
Contributor Author

Hello @jdaugherty, hope you're doing well. I wanted to follow up on the status of this PR whenever it's convenient for you.

@testlens-app
Copy link
Copy Markdown

testlens-app bot commented Mar 31, 2026

✅ All tests passed ✅

🏷️ Commit: c721a4b
▶️ Tests: 19016 executed
⚪️ Checks: 31/31 completed


Learn more about TestLens at testlens.app.

@jdaugherty
Copy link
Copy Markdown
Contributor

jdaugherty commented Apr 7, 2026

I checked this out and reran the build on this, I'm still seeing the section title otu of sequence warnings:

Rendering document file hookingIntoRuntimeConfiguration.adoc
: line 23: section title out of sequence: expected level 1, got level 3
: line 54: section title out of sequence: expected level 1, got level 3
: line 62: section title out of sequence: expected level 1, got level 3
: line 86: section title out of sequence: expected level 1, got level 3

These warnings too:

WARNING: programmaticTransactions.adoc: line 59: section title out of sequence: expected level 1, got level 3
Apr 07, 2026 4:16:45 PM uri:classloader:/gems/asciidoctor-2.0.18/lib/asciidoctor/document.rb parse
WARNING: eventsAutoTimestamping.adoc: line 36: section title out of sequence: expected level 1, got level 3
Apr 07, 2026 4:16:45 PM uri:classloader:/gems/asciidoctor-2.0.18/lib/asciidoctor/document.rb parse
WARNING: eventsAutoTimestamping.adoc: line 59: section title out of sequence: expected level 1, got level 3

@sanjana2505006 sanjana2505006 force-pushed the fix/docs-title-sequence branch from 01ede05 to 504875a Compare April 11, 2026 17:46
@sanjana2505006
Copy link
Copy Markdown
Contributor Author

I checked this out and reran the build on this, I'm still seeing the section title otu of sequence warnings:

Rendering document file hookingIntoRuntimeConfiguration.adoc : line 23: section title out of sequence: expected level 1, got level 3 : line 54: section title out of sequence: expected level 1, got level 3 : line 62: section title out of sequence: expected level 1, got level 3 : line 86: section title out of sequence: expected level 1, got level 3

These warnings too:

WARNING: programmaticTransactions.adoc: line 59: section title out of sequence: expected level 1, got level 3 Apr 07, 2026 4:16:45 PM uri:classloader:/gems/asciidoctor-2.0.18/lib/asciidoctor/document.rb parse WARNING: eventsAutoTimestamping.adoc: line 36: section title out of sequence: expected level 1, got level 3 Apr 07, 2026 4:16:45 PM uri:classloader:/gems/asciidoctor-2.0.18/lib/asciidoctor/document.rb parse WARNING: eventsAutoTimestamping.adoc: line 59: section title out of sequence: expected level 1, got level 3

My bad, I missed that those specific files were still throwing warnings. I’ve updated the fragment structure to use Level 0/1 headers and adjusted the leveloffset in the index files. This should solve the standalone rendering issues and clear the sequence warnings for good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Documentation: Cleanup Title Sequence

3 participants