[
https://issues.apache.org/jira/browse/SOLR-17553?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Eric Pugh reassigned SOLR-17553:
--------------------------------
Assignee: Eric Pugh
> Embed tool --help output into RefGuide
> --------------------------------------
>
> Key: SOLR-17553
> URL: https://issues.apache.org/jira/browse/SOLR-17553
> Project: Solr
> Issue Type: Sub-task
> Components: cli, documentation
> Reporter: Eric Pugh
> Assignee: Eric Pugh
> Priority: Major
>
> Keeping the Ref Guide documentation and the Tool documentation in sync is
> error prone and labour intensive.
> Can we just have the Ref Guide building process execute the tool --help
> option and include the output in the ref guide?
>
> The idea is to run bin/solr create --help --help-format asciidoc and get back
> AsciiDoc output that via a Antora plugin get's dropped into the right Ref
> guide place.
> Alternatively, maybe we add a Gradle task that does this indepdently, like a
> "generateHelpDocs".
>
> First step is to get AsciiDocs from our help, which is a feature of the
> upcoming commons-cli version. This is a follow up to SOLR-16797
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
