epugh opened a new pull request, #5176: URL: https://github.com/apache/solr/pull/5176
## Summary Fixes a batch of small, objective bugs across the Solr Reference Guide, found by manually reviewing the built site and then doing a systematic sweep for the same bug classes across all 291 pages: - **Broken tabs**: several pages used an incorrect `[.tab-label]` syntax instead of Antora's `[tabs#id]` block syntax, so the V1/V2 API examples rendered as static text instead of interactive tabs (`user-managed-index-replication.adoc`, `date-formatting-math.adoc`, `filters.adoc`). Also restructured `node-roles.adoc`'s Roles API examples to the same `[tabs#id]` convention used elsewhere, then simplified back to plain `curl` blocks once review determined a single-tab wrapper added no value for V2-only endpoints. - **Duplicate examples**: several pages repeated the exact same URL/command once in a `[tabs#id]` block and again under a separate "Examples using X" section with a redundant `*Input*` header (`cluster-node-management.adoc`, `alias-management.adoc` — later partially reverted per review, see below). Removed the redundant repeats, kept the `*Output*`. - **Stale version info**: `system-requirements.adoc` showed a Java 11 example and claimed the Docker image uses OpenJDK 17 (it's actually 25) and that Solr 9.x is the current stable line (it's 10.x now, with 11.0 in development per `build.gradle`). `jvm-settings.adoc` had two similarly stale Java-version qualifiers. - **Dead references**: `installing-solr.adoc` listed a `post` script as a standalone `bin/` file (it's actually a `bin/solr post` subcommand) and a `files` example directory that no longer exists in `solr/example/`. `enabling-ssl.adoc` referenced a `post.jar` example that isn't on the page anymore (the real example uses `bin/solr post`). - **Non-rendering code blocks**: `json-combined-query-dsl.adoc` used Markdown-style triple-backtick fences for 5 XML/JSON examples, which Asciidoctor doesn't recognize — converted to proper `[source,xml]`/`[source,json]` blocks. - Also fixed a duplicated page title (`"User-Managed Index Replication Index Replication"` → `"User-Managed Index Replication"`). Everything was verified by building the site locally (`./gradlew :solr:solr-ref-guide:buildLocalSite`) and checking the rendered HTML, including clicking through the fixed tabs in a browser. Also confirmed ref-guide-wide that there are zero broken `xref:` links (408 unique targets checked across all 8 modules) and zero broken `image::` references (346 checked). This is a pure bug-fix/formatting batch. A separate PR (#TBD) carries the one editorial content change (reworking the "Preparing for Installation" section's recommendations) that was originally bundled with these fixes but was split out after review. ## Test plan - [x] `./gradlew :solr:solr-ref-guide:buildLocalSite` succeeds - [x] Manually verified each fixed tabs block renders as an interactive tab and toggles correctly - [x] Manually verified duplicate-URL sections now show a single example - [x] Verified stale-fact corrections against actual source (`gradle/libs.versions.toml`, `build.gradle`, `solr/docker/build/dockerfiles/Dockerfile.local`, `solr/example/`, `solr/bin/`) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
