SOLR-18463: Rename Post Tool and Stream Tool to Post Command and Stream Command - #4924
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
…am Command Both were standalone tools historically and are now bin/solr subcommands, so calling them Tool alongside their own page titles and headings is no longer accurate. Left one occurrence untouched: the verbatim --help output on the Post Command page, which reflects the actual CLI text and would need a Java change, not a doc change.
Contributor
Author
|
@epugh tagging you since this is under SOLR-18459/SOLR-18463, which you filed. |
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-18463
Description
The ref guide has two pages,
post-tool.adocandstream-tool.adoc, that callbin/solr postandbin/solr stream"the Post Tool" and "the Stream Tool" (and, in two places, the one-word formsPostTool/StreamTool). Both used to be standalone tools, but are now bin/solr subcommands, so the "Tool" framing reads as if they were still separate products.Solution
Renamed both to "Post Command" and "Stream Command" in the page titles, section headings, and prose across
post-tool.adoc,stream-tool.adoc,tutorial-diy.adoc, andstreaming-expressions.adoc(13 sites total). Allxref:...[]links to these pages use empty link text, so they pick up the new titles automatically.Left one occurrence untouched: the
--helpoutput block on the Post Command page is verbatim output ofbin/solr post -h, not authored prose — changing it there would misrepresent what the CLI actually prints. That text lives inPostTool.javaand would need a code change, not a doc change.Tests
Ran
./gradlew :solr:solr-ref-guide:buildLocalAntoraSiteand:checkSiteLinksbefore and after: same 6 pre-existing warnings (unrelated, tracked separately in SOLR-18464/#4922), no new ones, no broken links.AI-assisted (Claude Sonnet 5).