Uploaded image for project: 'Solr'
  1. Solr
  2. SOLR-13235

Split Ref Guide Collections API page into several sub-pages

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: master (9.0), 8.2
    • Component/s: documentation
    • Labels:
      None

      Description

      The Collections API page in the Ref Guide has become the de-facto place where information about how to work with Solr collections is stored, but it is so huge with API examples that information gets lost.

      I did some work a couple months ago to split this up, and came up with this approach to splitting up the content:

      • Cluster and Node Management: Define properties for the entire cluster; check the status of a cluster; remove replicas from a node; utilize a newly added node; add or remove roles for a node.
      • Collection Management: Create, list, reload and delete collections; set collection properties; migrate documents to another collection; rebalance leaders; backup and restore collections.
      • Collection Aliasing: Create, list or delete collection aliases; set alias properties.
      • Shard Management: Create and delete a shard; split a shard into two or more additional shards; force a shard leader.
      • Replica Management: Add or delete a replica; set replica properties; move a replica to a different node.

      My existing local WIP leaves info on Async commands on the main collections-api.adoc page, but creates new pages for each of the bullets mentioned above, and moves the related API calls to those pages. Each topic will be smaller and easier for us to manage on an ongoing basis.

      Since I did the work a while ago, I need to bring it up to date with master, so a patch & a branch with this work will be forthcoming shortly.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                ctargett Cassandra Targett
                Reporter:
                ctargett Cassandra Targett
              • Votes:
                0 Vote for this issue
                Watchers:
                2 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 - 1h 10m
                  1h 10m