Skip to content

SOLR-18464: Fix three Antora build warnings in the ref guide - #4922

Open
serhiy-bzhezytskyy wants to merge 1 commit into
apache:mainfrom
serhiy-bzhezytskyy:SOLR-18464-antora-build-warnings
Open

serhiy-bzhezytskyy wants to merge 1 commit into
apache:mainfrom
serhiy-bzhezytskyy:SOLR-18464-antora-build-warnings

Conversation

@serhiy-bzhezytskyy

Copy link
Copy Markdown
Contributor

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: a cols="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) removed ADDROLE/REMOVEROLE, leaving 16 — not divisible by 3, so Asciidoctor drops cells from the resulting incomplete last row. The rendered page has likely been missing REBALANCELEADERS since that PR merged.

  • configuration-guide/pages/configsets-api.adoc (2 places) and indexing-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:buildLocalAntoraSite and :checkSiteLinks before and after: 1 error + 5 warnings → 0. No other pages affected.

AI-assisted (Claude Sonnet 5).

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.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Sep 20, 2026
@serhiy-bzhezytskyy

Copy link
Copy Markdown
Contributor Author

@epugh tagging you since this is under SOLR-18459/SOLR-18464, which you filed.

@malliaridis malliaridis left a comment

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.

LGTM. Addresses the warnings shown when running the buildLocalSite task. Thanks for addressing these.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants