[
https://issues.apache.org/jira/browse/SOLR-17403?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17872697#comment-17872697
]
Eric Pugh commented on SOLR-17403:
----------------------------------
It would be awesome if we could capture the output of the bin/solr create -h
type commands and feed it into Antora. Either as plain text, or maybe a HTML
help formatter in the commons CLI project?
I asked for some ideas:
https://antora.zulipchat.com/#narrow/stream/282400-users/topic/How.20can.20I.20capture.20the.20--help.20output.20of.20my.20CLI.20in.20my.20docs.3F
> Restructure Ref Guide Page Solr Control Script Reference
> --------------------------------------------------------
>
> Key: SOLR-17403
> URL: https://issues.apache.org/jira/browse/SOLR-17403
> Project: Solr
> Issue Type: Sub-task
> Components: cli, documentation
> Reporter: Eric Pugh
> Priority: Major
>
> The Ref Guide page Solr Control Script Reference
> (solr-control-script-reference.adoc) is currently a mess. It is trying to
> cover way way too much!
> We need to rethink how we document the Solr CLI. The goals are:
> 1) Make it easy for folks to know where to find docs about the CLI.
> 2) Break the page up so we can grow it in the future. (see how we have
> seperate pages for package management for example)
> 3) Think about how we document parameters. Do we want to still have our
> manual docs for parameters, or maybe provide examples and leave cli docs up
> to the Java code? (bin/solr mycommand -h). Or even just cut n paste the -h
> output into the ref guide?
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org
For additional commands, e-mail: issues-h...@solr.apache.org
