[DOCS] Add CCR docs to the Elasticsearch Reference Guide#45704
[DOCS] Add CCR docs to the Elasticsearch Reference Guide#45704jrodewig merged 9 commits intoelastic:masterfrom jrodewig:add-ccr-to-es-ref
Conversation
jrodewig
added
>docs
|
Pinging @elastic/es-distributed |
|
Pinging @elastic/es-docs |
Previously, cross-cluster replication (CCR) documentation was located in the Stack Overview: https://www.elastic.co/guide/en/elastic-stack-overview/master/xpack-ccr.html This adds CCR documentation to the Elasticsearch Reference Guide with a level offset for headings. The level offset and CCR Stack Overview docs will be removed in later commits.
|
This PR builds successfully for me. I was a little surprised, however, at the location chosen for this content. I thought it might be closer (in location and title) to the CCS content (https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-cross-cluster-search.html). |
|
I chose Administering Elasticsearch because that section seemed more relevant for common use cases:
Aside from both requiring remote clusters, the concepts don't seem particularly dependent on or tied to each other. That said, I'm happy to relocate and open to any suggestions. It's better to move once than twice. |
|
I'm not up to speed on all the Elasticsearch content reorganization plans, I just thought since there's a "Search across clusters" at the top level, it would be nice to have something like "Replicate across clusters" too. As a plus, that way you don't lose the sub-pages under the CCR "Overview". I'm fine with whatever you decide, however. |
|
d883beb relocates the CCR chapter to the top level, following "Search across clusters" |
debadair
left a comment
debadair
left a comment
There was a problem hiding this comment.
We need to be consistent about where we put admin topics--having some under "Administration" and some at the top level is confusing. CCS has both an admin configuration element and a search usage element, where CCR is more purely an admin topic. If we opt to bump the admin topics to the top level, I think we need to group them. Putting CCR in between the Query DSL and Scripting and Mapping sections doesn't seem like the right place. One option might be to split the info on how to write a query to search multiple clusters from how to set up remotes and enable cross-cluster search and cross-cluster replication.
|
We already document remote clusters separately: https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-remote-clusters.html The only admin piece of CCS is a very brief setup example here: I can remove that setup if wanted, but I think it helps give the user a start-to-finish CCS setup. |
|
Spoke to @debadair. I'm going to hold off on merging this and any other architecture-related PRs pending some more team discussion. Adding a |
elastic/elasticsearch#45704 and elastic/stack-docs#464 moves the cross-cluster replication (CCR) docs from the Elastic Stack Overview to the Elasticsearch Reference Guide. This updates any links pointing to the old Elastic Stack Overview docs. We've set up redirects so these links won't fail in the meantime. This just removes a step for users.
…3729) elastic/elasticsearch#45704 and elastic/stack-docs#464 moves the cross-cluster replication (CCR) docs from the Elastic Stack Overview to the Elasticsearch Reference Guide. This updates any links pointing to the old Elastic Stack Overview docs. We've set up redirects so these links won't fail in the meantime. This just removes a step for users.
…3730) elastic/elasticsearch#45704 and elastic/stack-docs#464 moves the cross-cluster replication (CCR) docs from the Elastic Stack Overview to the Elasticsearch Reference Guide. This updates any links pointing to the old Elastic Stack Overview docs. We've set up redirects so these links won't fail in the meantime. This just removes a step for users.
…) (elastic#13729) elastic/elasticsearch#45704 and elastic/stack-docs#464 moves the cross-cluster replication (CCR) docs from the Elastic Stack Overview to the Elasticsearch Reference Guide. This updates any links pointing to the old Elastic Stack Overview docs. We've set up redirects so these links won't fail in the meantime. This just removes a step for users.
…) (elastic#13730) elastic/elasticsearch#45704 and elastic/stack-docs#464 moves the cross-cluster replication (CCR) docs from the Elastic Stack Overview to the Elasticsearch Reference Guide. This updates any links pointing to the old Elastic Stack Overview docs. We've set up redirects so these links won't fail in the meantime. This just removes a step for users.
6 participants
Changes
Previously, cross-cluster replication (CCR) documentation was located only in
the Stack Overview. This inclusion requires level-offsets, which will be removed in a later PR.
Relates to #45703
Preview
http://elasticsearch_45704.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/xpack-ccr.html