Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-16757 Umbrella Ticket for Revamping Solr CLI's for the Future
  3. SOLR-16797

Migrate detailed help/examples/tips from Solr CLI -h output to Ref Guide

    XMLWordPrintableJSON

Details

    • Sub-task
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • main (10.0), 9.2
    • main (10.0), 9.3
    • cli, documentation
    • None

    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.

      Attachments

        Issue Links

          Activity

            People

              epugh Eric Pugh
              epugh Eric Pugh
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - Not Specified
                  Not Specified
                  Remaining:
                  Remaining Estimate - 0h
                  0h
                  Logged:
                  Time Spent - 0.5h
                  0.5h