janhoy commented on code in PR #4271:
URL: https://github.com/apache/solr/pull/4271#discussion_r3050866614
##########
solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc:
##########
@@ -25,6 +25,47 @@ The SolrCLI makes Solr easier to work with by providing
simple commands and opti
More examples of SolrCLI in use are available throughout this Guide,
particularly in the sections xref:installing-solr.adoc#starting-solr[Starting
Solr] and xref:getting-started:tutorial-solrcloud.adoc[].
+== Command Reference
+
+The table below lists all available `bin/solr` commands.
+Commands marked with (✓) have dedicated reference pages auto-generated from
source annotations; others are documented inline below.
Review Comment:
This section is temporary, not intended for release. I suppose this entire
"landing page" needs to be re-written in a way that gives a good overview,
without touching the details.
**Question:** Currently we have usage examples hand written in the ref-guide
page. We could instead add usage examples for each tool either in the
description field or footer field, or some custom annotation that we invent and
tie in when generating docs:
```java
@Command(
name = "myapp",
footerHeading = "%nExamples:%n",
footer = {
" # Basic usage",
" myapp --input foo.txt",
"",
" # With options",
" myapp --input foo.txt --verbose"
}
)
```
I think perhaps using footer for this purpose is a good approach, this way
also the `--help` for each tool will print usage examples. I think we can
sacrifice the current refguide URL link we have in all the footers. It can
perhaps be included on the main `bin/solr` command only.
--
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]
