elastic / elastic/docs-content
Refactor cross-cluster search docs
- Dominant language
- No language data
- Stars
- 47
- Forks
- 261
- Avg merge
- 3d 21h
- Merged PRs (30d)
- 141
Description
Page: https://www.elastic.co/docs/explore-analyze/cross-cluster-search
## Problem
- The current cross-cluster search (CCS) page mixes multiple content types: overview, setup, tutorial, API reference, troubleshooting, and upgrade planning. This may have made sense historically as a single Elasticsearch reference module, but it conflicts with our content-type expectations. The size of the page is overwhelming for any user to manage and it makes finding things more difficult (content is not easy to scan).
- Consequences: readers who want to run a query must wade through async-polling JSON and implementation details; readers planning upgrades may never reach the compatibility table at the bottom; maintainability and discoverability suffer.
## Proposed solution
The docs could be split into an overview hub, task how-tos, reference, and possibly troubleshooting. The setup vs solution workflows must be easier to find and focus on.
I ran into this page as part of https://github.com/elastic/docs-content/pull/6934 while moving the CCS-specific privileges info and noticed this, so wanted to log a backlog item for it.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the cross-cluster search page at https://www.elastic.co/docs/explore-analyze/cross-cluster-search and inventory its overview, setup, tutorial, API reference, troubleshooting, and upgrade-planning content. Define a split into an overview hub, task how-tos, reference, and possibly troubleshooting, with setup and solution workflows easier to find; done means the content is separated and discoverable without the current scanning burden.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100