[SOLR-17553] Embed tool --help output into RefGuide

• Type: Sub-task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: cli, documentation
• Assignee: Eric Pugh
• Reporter: Eric Pugh
• Created: 12/Nov/24 11:51
• Updated: 12/Nov/24 11:51

Description

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