[
https://issues.apache.org/jira/browse/SOLR-13235?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16862206#comment-16862206
]
Cassandra Targett commented on SOLR-13235:
------------------------------------------
I closed the PR as I didn't get it done in the timeline I hoped and now there
are all sort of merge conflicts it would take forever to straighten out. I'll
make the same changes as that PR but not via the branch/PR.
It occurred to me yesterday splitting up the collections-api page also requires
updating the doc links in all the API specs in
{{solr/solrj/src/java/resources/apispec}}, so I will include that also.
> Split Ref Guide Collections API page into several sub-pages
> -----------------------------------------------------------
>
> Key: SOLR-13235
> URL: https://issues.apache.org/jira/browse/SOLR-13235
> Project: Solr
> Issue Type: Improvement
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
> Priority: Major
> Fix For: master (9.0), 8.2
>
> Time Spent: 1h 10m
> Remaining Estimate: 0h
>
> 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.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org
For additional commands, e-mail: dev-h...@lucene.apache.org
