Swikar Patel created KAFKA-18111:
------------------------------------
Summary: Improve README: Add logo, component table, and use case
descriptions
Key: KAFKA-18111
URL: https://issues.apache.org/jira/browse/KAFKA-18111
Project: Kafka
Issue Type: Improvement
Components: docs, documentation
Reporter: Swikar Patel
h2. Proposed README Improvements
This issue proposes several enhancements to the Kafka README file to improve
its clarity, organization, and accessibility for new users.
*Specific Changes:*
# *Add Kafka Logo:*
** Include the official Apache Kafka logo at the top of the README for better
branding and visual appeal. The logo can be found on the Apache Kafka website
under the "Resources" or "Branding" section. I will use an SVG version of the
logo for optimal scaling.
# *Component Table:*
** Create a table listing the core Kafka components with brief descriptions
and links to relevant documentation for each. This will help users quickly
understand the key parts of Kafka.
** *Proposed Table Format:*
| Component | Description | Documentation Link | |---|---|---| | Brokers | | |
| Topics | | | | Producers | | | | Consumers | | | | Connect | | | | Streams |
| |
# *Use Case Descriptions:*
** Add a section with clear and concise descriptions of common Kafka use
cases. This will help users understand how Kafka can be applied in real-world
scenarios.
** *Proposed Use Cases:*
*** Messaging system
*** Website activity tracking
*** Stream processing
*** Event sourcing
*** Commit log
** Include links to external resources or the Kafka website for more detailed
information on specific use cases.
*Goals:*
* Make the README more visually engaging and informative.
* Help users quickly understand the core components and use cases of Kafka.
* Improve the overall user experience for those new to Kafka.
*Additional Notes:*
* I will ensure the logo is used in accordance with Apache licensing
guidelines.
* I am open to suggestions and feedback on the table format, use case
descriptions, and overall structure of the README.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
