[SOLR-16797] Migrate detailed help/examples/tips from Solr CLI -h output to Ref Guide

• Type: Sub-task
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: main (10.0), 9.2
• Fix Version/s: main (10.0), 9.3
• Component/s: cli, documentation
• Assignee: Eric Pugh
• Reporter: Eric Pugh
• Created: 10/May/23 18:34
• Updated: 21/Jul/23 20:40
• Resolved: 09/Jun/23 10:34

Description

Many of our CLI tools have detailed docs about how to use them when you invoke them iwth a -h. In parallel we have docs in the Ref Guide. Let's migrate the detailed docs from the CLI -h invoked option to the ref guide. Maybe think about how we can point a user to the correct Ref Guide page if they do a -h?

This will reduce the duplication, where errors creep in, and reduce the amount of custom java code.

Issue Links

• links to: GitHub Pull Request #1667