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] Sizing shards rewrite #120346

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

thekofimensah
Copy link
Contributor

This is a really important internal document and is a question that many people struggle with. I’ve tried to make it as clear and direct as possible while packing in useful information right from the start. I’d appreciate it if someone could review it for accuracy and share any thoughts or suggestions on the approach.

Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v9.0.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jan 17, 2025
@tvernum tvernum added the >docs General docs changes label Jan 17, 2025
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Jan 17, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine removed the needs:triage Requires assignment of a team area label label Jan 17, 2025
@tvernum tvernum added :Distributed Indexing/Distributed A catch all label for anything in the Distributed Area. Please avoid if you can. needs:triage Requires assignment of a team area label and removed Team:Docs Meta label for docs team needs:triage Requires assignment of a team area label labels Jan 17, 2025
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Distributed Indexing Meta label for Distributed Indexing team labels Jan 17, 2025
@elasticsearchmachine
Copy link
Collaborator

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

@leemthompo leemthompo changed the title Kofi sizing shards rewrite [DOCS] Sizing shards rewrite Jan 17, 2025
@leemthompo
Copy link
Contributor

A more detailed PR description would be helpful for reviewers. Something like:

Key Changes:

  • Added concrete shard sizing recommendations (10GB-50GB, <200M docs per shard)
  • Introduced new "What is a shard?" section explaining core concepts
  • Restructured introduction to emphasize balanced distribution and monitoring importance
  • Removed video links (why?)
  • Improved readability with clearer structure and bullet points

@thekofimensah
Copy link
Contributor Author

Thanks for the note @leemthompo . Will do that structure later on to make it easier for reviewers.

FYI, I'm confused about the youtube links. I didn't remove them and I couldn't find them in the original doc, so I don't know how I deleted them. Is there something I'm missing?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Indexing/Distributed A catch all label for anything in the Distributed Area. Please avoid if you can. >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Distributed Indexing Meta label for Distributed Indexing team Team:Docs Meta label for docs team v9.0.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants