update: improve single-AZ Kafka docs #1193
Conversation
Deploying aiven-docs with
|
| Latest commit: |
b5badb1
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://65f196cd.aiven-docs.pages.dev |
| Branch Preview URL: | https://fleet-6228-clarify-data-loss.aiven-docs.pages.dev |
There was a problem hiding this comment.
Pull request overview
This PR improves the Apache Kafka best practices documentation by clarifying guidance on single-AZ deployments for BYOC customers. The changes enhance readability through clearer, more concise language and expand the single-AZ section with detailed risk assessments, replication factor implications, and usage recommendations.
- Enhanced single-AZ section with comprehensive guidance on risks, appropriate use cases, and SLA requirements
- Improved clarity and conciseness across all sections by simplifying technical explanations
- Updated title to better reflect the document's purpose
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| To enable this option for your project, contact [Aiven support](mailto:[email protected]) | ||
| or your account team. |
There was a problem hiding this comment.
Line length exceeds 90 characters: According to the PR checklist, lines should have a line break at 90 characters. This line exceeds that limit. Consider breaking it before "contact":
To enable this option for your project, contact
[Aiven support](mailto:[email protected]) or your account team.| To enable this option for your project, contact [Aiven support](mailto:[email protected]) | |
| or your account team. | |
| To enable this option for your project, | |
| contact [Aiven support](mailto:[email protected]) or your account team. |
| A maximum of 4,000 partitions per broker and 200,000 per cluster is recommended. For more | ||
| details, see this [Apache Kafka blog post](https://blogsarchive.apache.org/kafka/entry/apache-kafka-supports-more-partitions). | ||
| In addition, the total number of topics per cluster should remain under 7,000. | ||
| A maximum of 4,000 partitions per broker and 200,000 per cluster is recommended. For details, see this |
There was a problem hiding this comment.
Line length exceeds 90 characters: According to the PR checklist, lines should have a line break at 90 characters. This line appears to exceed that limit. Consider breaking it after "recommended" or "details":
A maximum of 4,000 partitions per broker and 200,000 per cluster is recommended. For
details, see this [Apache Kafka blog post]...| A maximum of 4,000 partitions per broker and 200,000 per cluster is recommended. For details, see this | |
| A maximum of 4,000 partitions per broker and 200,000 per cluster is recommended. | |
| For details, see this |
Describe your changes
Clarifies single-AZ BYOC Kafka risks, usage guidance, and SLA requirements. Improves section formatting and terminology.
FLEET-6228
Checklist
/docs/.