You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@solr.apache.org by "Eric Pugh (Jira)" <ji...@apache.org> on 2024/11/12 11:52:00 UTC

[jira] [Assigned] (SOLR-17553) Embed tool --help output into RefGuide

     [ 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: issues-unsubscribe@solr.apache.org
For additional commands, e-mail: issues-help@solr.apache.org