Enhance README with improved Kafka description #21124
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the description of Apache Kafka for clarity and added an architecture image.
|
A label of 'needs-attention' was automatically added to this PR in order to raise the |
AndrewJSchofield
requested changes
Jan 2, 2026
Member
AndrewJSchofield
left a comment
AndrewJSchofield
left a comment
There was a problem hiding this comment.
Thanks for the PR. I have left some comments.
README.md
Outdated
| [**Apache Kafka**](https://kafka.apache.org) is an open-source distributed event streaming platform used by thousands of companies for high-performance data pipelines, streaming analytics, data integration, and mission-critical applications. | ||
| [**Apache Kafka**](https://kafka.apache.org) is an open source, highly scalable, fault-tolerant, distributed event-streaming platform designed for real-time data ingestion, processing, and distribution. It enables applications to publish, store, and consume continuous streams of records with high throughput and durability, making it a core infrastructure component for building data pipelines, streaming analytics systems, and mission-critical, event-driven architectures. | ||
|
|
||
| Acchitecture of Apache Kafka: |
Member
There was a problem hiding this comment.
nit: "architecture" not "accitecture".
README.md
Outdated
| [**Apache Kafka**](https://kafka.apache.org) is an open source, highly scalable, fault-tolerant, distributed event-streaming platform designed for real-time data ingestion, processing, and distribution. It enables applications to publish, store, and consume continuous streams of records with high throughput and durability, making it a core infrastructure component for building data pipelines, streaming analytics systems, and mission-critical, event-driven architectures. | ||
|
|
||
| Acchitecture of Apache Kafka: | ||
| <img width="772" height="562" alt="kafka drawio" src="https://github.com/user-attachments/assets/f1dda78b-0826-4408-92ba-6aef364f1b3a" /> |
Member
There was a problem hiding this comment.
This image is not helpful. It includes Zookeeper which was removed from Kafka in the 4.0 release. Personally, I would prefer not to include an image in the repo readme file.
Author
|
Fixed the changes requested. Corrected the typo and removed the image according to your preferance |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This commit updates the existing Kafka definition to a more precise, technically grounded, and documentation-ready description. The new version provides clearer context on Kafka’s purpose, core capabilities, and role in modern data systems, improving onboarding for new contributors and enhancing the overall readability of our documentation.
Motivation
The previous definition, while correct, lacked depth and did not fully convey Kafka’s strengths as a distributed event-streaming platform. Clear and accurate documentation is essential for both internal developers and external users evaluating or onboarding to the project. This improvement ensures the definition better reflects Kafka’s architectural guarantees scalability, durability, fault tolerance and aligns with industry-standard terminology.
What’s Changed
Benefits
Helps future contributors by providing clearer context up front.