[
https://issues.apache.org/jira/browse/SOLR-16797?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17730911#comment-17730911
]
ASF subversion and git services commented on SOLR-16797:
--------------------------------------------------------
Commit edc2427ae27a7e7e745ebb26f7029d7bbf7d62e9 in solr's branch
refs/heads/main from Eric Pugh
[ https://gitbox.apache.org/repos/asf?p=solr.git;h=edc2427ae27 ]
SOLR-16797: Migrate detailed help/examples/tips from Solr CLI -h output to Ref
Guide (#1667)
* migrate content from bin/solr api -h
* review export command
* match same text used in create_collection and others...
* match what ref guide suggest the tool takes as params.
* bin/solr config command
* didnt have energy to do lots of adoc, so slapped it in like we did the post
tool docs ;-)
* small refactor
* migrate "the good stuff" from bin/solr auth -h
* grab some nice words from bin/solr delete -h
* expand on the create core or collection docs to have a core specific and
collection specific sections, pulled from content from bin/solr create,
create_core, and create_collection.
* small formatting fix, nothing else from bin/solr healthcheck needed
* small wording tweak
* migrate some great content out of bin/solr restart -h
* wordsmithing from bin/solr stop -h
* go through bin/solr zk -help and pull out content
* pulled out content from bin/solr package -h
> Migrate detailed help/examples/tips from Solr CLI -h output to Ref Guide
> ------------------------------------------------------------------------
>
> Key: SOLR-16797
> URL: https://issues.apache.org/jira/browse/SOLR-16797
> Project: Solr
> Issue Type: Sub-task
> Components: cli, documentation
> Affects Versions: main (10.0), 9.2
> Reporter: Eric Pugh
> Assignee: Eric Pugh
> Priority: Minor
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> Many of our CLI tools have detailed docs about how to use them when you
> invoke them iwth a -h. In parallel we have docs in the Ref Guide. Let's
> migrate the detailed docs from the CLI -h invoked option to the ref guide.
> Maybe think about how we can point a user to the correct Ref Guide page if
> they do a -h?
> This will reduce the duplication, where errors creep in, and reduce the
> amount of custom java code.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
