[SOLR-17403] Restructure Ref Guide Page Solr Control Script Reference

• Type: Sub-task
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Component/s: cli, documentation
• Assignee: Unassigned
• Reporter: Eric Pugh
• Created: 11/Aug/24 14:32
• Updated: 12/Aug/24 10:54

Description

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?