Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] An overview page for CCS like for ILM #62106

Closed
Alex3k opened this issue Sep 8, 2020 · 5 comments
Closed

[DOCS] An overview page for CCS like for ILM #62106

Alex3k opened this issue Sep 8, 2020 · 5 comments
Labels
>docs General docs changes >enhancement :Search/Search Search-related issues that do not fall into other categories Team:Docs Meta label for docs team Team:Search Meta label for search team

Comments

@Alex3k
Copy link

Alex3k commented Sep 8, 2020

Summary
I find the CCS docs quite heavy on technical detail on the root page whereas other pages like the ILM docs have a great, very approachable brief summary and then solid overview section.

Detail
Within the ILM docs, you get a really brief introduction to ILM with a screenshot that gives a bit more detail and then various sections such as Overview and Concepts. This documentation in my mind if the gold standard when sharing with customers as I don't need to reinvent the wheel when trying to describe that it's useful.
image

However, I find when trying to encourage folks towards CCS it gets a bit more complicated. The documentation dive straight into a lot of detail around APIs without giving any detail more than a few line of why it is useful and how it can be used for critical topics like disaster recovery. It would be great to see possible architectures of this in use and how folks can use it.

image

It would be really great and useful if we could structure the CCS documentation to be closer to the structure of ILM. For example, the root page could be titled "Cross Cluster Search" and then an overview of what it is, how it can be used, scenarios of use, common architectures and how to set it up and limitations would be awesome.

cc: @zuketo

@Alex3k Alex3k added >enhancement >docs General docs changes Team:Docs Meta label for docs team labels Sep 8, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@jrodewig jrodewig assigned jrodewig and unassigned jrodewig Sep 8, 2020
@lockewritesdocs lockewritesdocs added :Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. and removed Team:Docs Meta label for docs team labels Apr 27, 2022
@elasticmachine elasticmachine added the Team:Distributed Meta label for distributed team label Apr 27, 2022
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@pxsalehi pxsalehi added :Search/Search Search-related issues that do not fall into other categories and removed :Distributed/Distributed A catch all label for anything in the Distributed Area. If you aren't sure, use this one. Team:Distributed Meta label for distributed team labels Jul 28, 2022
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Search Meta label for search team labels Jul 28, 2022
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-search (Team:Search)

@abdonpijpelink abdonpijpelink removed their assignment Jan 26, 2024
@javanna
Copy link
Member

javanna commented Jun 24, 2024

This has been open for quite a while, and hasn't had a lot of interest. For now I'm going to close this as something we aren't planning on implementing. We can re-open it later if needed.

@javanna javanna closed this as not planned Won't fix, can't repro, duplicate, stale Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes >enhancement :Search/Search Search-related issues that do not fall into other categories Team:Docs Meta label for docs team Team:Search Meta label for search team
Projects
None yet
Development

No branches or pull requests

8 participants