SOLR-18469: Use the tabs format for v1/v2 API examples in two pages - #4928
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
implicit-requesthandlers.adoc and basic-authentication-plugin.adoc listed v1 and v2 endpoints as plain text instead of the [tabs] V1/V2 API format used elsewhere in the guide. Converted every row that has both a v1 and v2 form; left the one row that only has v1 (Core Info) untouched, since there's nothing to pair it with.
Contributor
Author
|
@epugh tagging you since this is under SOLR-18459/SOLR-18469, which you filed. |
Contributor
|
I am surprised this pattern was more common across our code base? Maybe we need to also audit in another pr "places we show v1 but not v2" and have a v2.. |
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-18469
Description
implicit-requesthandlers.adoclisted v1/v2 endpoint pairs as plain text inside table cells instead of the[tabs]V1/V2 format used elsewhere in the guide. Grepped for the same pattern across the rest of the guide and found one other page with it:basic-authentication-plugin.adoc, which already uses[tabs]for its other examples on the same page, just not for its "API Entry Point" section.Solution
implicit-requesthandlers.adocuses compact 3-column reference tables (API Endpoint(s) | Class & Javadocs | Paramset) rather than full runnable examples, so the v1/v2 split lives inside a table cell. AsciiDoc table cells only support block content like[tabs]when markeda|instead of|. Converted every row that has both a v1 and v2 form this way: Health, Logging, Properties, Threads, Config, and Schema (which has two v1 paths and two v2 paths -- both lines go inside their respective tab). Left "Core Info" alone -- it only has a v1 endpoint, nothing documented for v2, so there's nothing to pair it with.basic-authentication-plugin.adoc's "API Entry Point" section (two bare URLs) converted to the same[tabs]style already used elsewhere on that same page.Tested the table-cell approach before applying it everywhere: converted one row, built the actual HTML (not just checked for a clean Asciidoctor pass), and confirmed the tabs/tabpanel/tablist structure renders the same way nested in a
<td>as it does at the top level.Tests
Ran
./gradlew :solr:solr-ref-guide:buildLocalAntoraSiteand:checkSiteLinks: same 6 pre-existing warnings (unrelated, tracked in #4922/SOLR-18464), no new ones, no broken links. Also ranbuildLocalSiteand inspected the generated HTML directly for the tabs DOM structure.AI-assisted (Claude Sonnet 5).