SOLR-18464: Fix three Antora build warnings in the ref guide - #4922
Open
serhiy-bzhezytskyy wants to merge 1 commit into
Open
serhiy-bzhezytskyy wants to merge 1 commit into
serhiy-bzhezytskyy wants to merge 1 commit into
Conversation
Two pages used unescaped {placeholder} syntax in path templates and example prompts, which Asciidoctor treats as document-attribute references. A third page's action-name table lost two rows in SOLR-18370 (apache#4772), leaving an odd count that made the table drop its last row's cells.
Contributor
Author
|
@epugh tagging you since this is under SOLR-18459/SOLR-18464, which you filed. |
This was referenced Sep 20, 2026
malliaridis
approved these changes
Sep 20, 2026
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
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.
https://issues.apache.org/jira/browse/SOLR-18464
Description
Building the ref guide site (
./gradlew :solr:solr-ref-guide:buildLocalAntoraSite) produces one error and several warnings:deployment-guide/pages/rule-based-authorization-plugin.adoc:425: acols="1,1,1"table listing collection-admin-edit's allowed actions had 18 entries when written, but SOLR-18370 (SOLR-18370: remove the ADDROLE/REMOVEROLE Overseer Roles API #4772) removedADDROLE/REMOVEROLE, leaving 16 — not divisible by 3, so Asciidoctor drops cells from the resulting incomplete last row. The rendered page has likely been missingREBALANCELEADERSsince that PR merged.configuration-guide/pages/configsets-api.adoc(2 places) andindexing-guide/pages/document-enrichment-with-llms.adoc(4 places): prose and example XML use literal{configSetName},{filePath}, and{string_field}as path/placeholder templates. Asciidoctor treats any{...}as a document-attribute reference by default, so it tries (and fails) to substitute an undefined attribute.Solution
Changed the table to
cols="1,1,1,1"(16 items / 4 columns = 4 even rows) instead of padding with empty cells.Escaped the opening brace (
\{configSetName},\{filePath},\{string_field}) so they render literally, matching the existing convention used elsewhere in the guide (e.g.deployment-guide/pages/node-roles.adoc,deployment-guide/pages/task-management.adoc).Tests
Ran
./gradlew :solr:solr-ref-guide:buildLocalAntoraSiteand:checkSiteLinksbefore and after: 1 error + 5 warnings → 0. No other pages affected.AI-assisted (Claude Sonnet 5).