KAFKA-18983 Ensure all README.md(s) are mentioned by the root README.md by johnny94 · Pull Request #19420 · apache/kafka

johnny94 · 2025-04-09T06:02:44Z

There are few README not added because I am not sure if they need to be mentioned in root README.

./test-common/test-common-internal-api/src/main/java/org/apache/kafka/common/test/api/README.md
./storage/src/test/java/org/apache/kafka/tiered/storage/README.md
./.github/workflows/README.md
./raft/README.md
./committer-tools/README.md

Reviewers: Ken Huang s7133700@gmail.com, TengYao Chi kitingiao@gmail.com, PoAn Yang payang@apache.org, Jhen-Yung Hsu jhenyunghsu@gmail.com, Chia-Ping Tsai chia7712@gmail.com

johnny94 · 2025-04-09T06:04:42Z


 Quickstart
 =========================================================
-First, we want to [start a single-node Kafka cluster in KRaft mode](https://github.com/apache/kafka/blob/trunk/README.md#running-a-kafka-broker-in-kraft-mode)


running-a-kafka-borker-in-kraft-mode no longer exist by #18301.
Also modified the sentence to align with the PR

frankvicky

@johnny94 : Thanks for the patch.
I have a comment.

frankvicky · 2025-04-09T06:14:32Z

 - image-type - This is the type of image that we intend to build. This will be dropdown menu type selection in the workflow.
  - `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/display/KAFKA/KIP-975%3A+Docker+Image+for+Apache+Kafka)
-  - `native` image type is for graalvm based `native` kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming)
+  - `native` image type is for graalvm based `native` kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming). Or you can see [native/README.md](native/README.md) for more information.


Could you please replace the KIP link with an immutable link?

Does immutable link mean the link created by the share button?

yep, for example, the immutable link of KIP-974 is https://cwiki.apache.org/confluence/x/KZizDw

Yunyung

Thanks for the PR. I left some comments.

Yunyung · 2025-04-09T06:14:45Z


    ./gradlew processMessages processTestMessages

+See [Apache Kafka Message Definitions](/clients/src/main/resources/common/message/README.md) for details on Apache Kafka message protocol


Yunyung · 2025-04-09T06:15:10Z


+### Using Trogdor for testing ###
+
+We Trogdor as a test framework for Apache Kafka. You can use it to run benchmarks and other workloads.


We "use" Trogdor?

FrankYang0529 · 2025-04-09T07:26:21Z


    docker run -p 9092:9092 apache/kafka:3.7.0

+See [docker/README.md] for detailed information.


This should be [docker/README.md](docker/README.md).

m1a2st

Thanks for this patch, a little comments

m1a2st · 2025-04-09T09:22:58Z

@@ -30,8 +30,8 @@ Building image and running tests using github actions
 - kafka-url - This is the url to download kafka tarball from. For example kafka tarball url from (https://archive.apache.org/dist/kafka). For building RC image this will be an RC tarball url.


Could you also update this link to markdown pattern

(https://archive.apache.org/dist/kafka) -> [Kafka archive](https://archive.apache.org/dist/kafka)

m1a2st · 2025-04-09T09:23:01Z

-  - `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/display/KAFKA/KIP-975%3A+Docker+Image+for+Apache+Kafka)
-  - `native` image type is for graalvm based `native` kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming)
+  - `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/x/z5izDw)
+  - `native` image type is for graalvm based `native` kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/x/KZizDw#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming). Or you can see [native/README.md](native/README.md) for more information.


"kafka docker image" could be "Kafka docker image"

frankvicky · 2025-04-10T07:54:33Z

-  - `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/display/KAFKA/KIP-975%3A+Docker+Image+for+Apache+Kafka)
-  - `native` image type is for graalvm based `native` kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/display/KAFKA/KIP-974%3A+Docker+Image+for+GraalVM+based+Native+Kafka+Broker#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming)
+  - `jvm` image type is for official docker image (to be hosted on apache/kafka) as described in [KIP-975](https://cwiki.apache.org/confluence/x/z5izDw)
+  - `native` image type is for graalvm based `native` Kafka docker image (to be hosted on apache/kafka-native) as described in [KIP-974](https://cwiki.apache.org/confluence/x/KZizDw#KIP974:DockerImageforGraalVMbasedNativeKafkaBroker-ImageNaming). Or you can see [native/README.md](native/README.md) for more information.


Could we only keep https://cwiki.apache.org/confluence/x/KZizDw ?

No preference. Just follow the original link.

Yunyung · 2025-04-14T08:21:49Z


    ./gradlew processMessages processTestMessages

+See [Apache Kafka Message Definitions](/clients/src/main/resources/common/message/README.md) for details on Apache Kafka message protocol.


Why is there a '/' in '/clients'? Can we remove it?

ijuma · 2025-04-16T02:13:51Z


 See [vagrant/README.md](vagrant/README.md).

+### Release Kafka ###


This is not something a regular person can do and hence it doesn't seem like something we should link from the main readme.

The original idea was to list all README.md files in the root directory, without filtering the content for specific readers. I'm fine to remove the "Release Kafka", and the "Official Documentation" could be removed too as the file "docs/README.md" has nothing to read

Addressed the feedback #19420 (comment) Reviewers: TengYao Chi <kitingiao@gmail.com>, PoAn Yang <payang@apache.org>, Chia-Ping Tsai <chia7712@gmail.com>

Addressed the feedback apache#19420 (comment) Reviewers: TengYao Chi <kitingiao@gmail.com>, PoAn Yang <payang@apache.org>, Chia-Ping Tsai <chia7712@gmail.com>

KAFKA-18983 Ensure all README.md(s) are mentioned by the root README.md

2e7b78e

github-actions bot added triage PRs from the community docs tools docker Official Docker image small Small PRs labels Apr 9, 2025

johnny94 commented Apr 9, 2025

View reviewed changes

chia7712 approved these changes Apr 9, 2025

View reviewed changes

mingyen066 added the ci-approved label Apr 9, 2025

frankvicky reviewed Apr 9, 2025

View reviewed changes

Yunyung reviewed Apr 9, 2025

View reviewed changes

FrankYang0529 reviewed Apr 9, 2025

View reviewed changes

Address feedback

4089ba0

m1a2st reviewed Apr 9, 2025

View reviewed changes

github-actions bot removed the triage PRs from the community label Apr 10, 2025

Address feedback

2725f42

frankvicky reviewed Apr 10, 2025

View reviewed changes

Address feedback

3747ed5

Yunyung reviewed Apr 14, 2025

View reviewed changes

Fix

cc731ed

frankvicky approved these changes Apr 15, 2025

View reviewed changes

chia7712 approved these changes Apr 15, 2025

View reviewed changes

chia7712 merged commit e9ca0bb into apache:trunk Apr 15, 2025
20 checks passed

ijuma reviewed Apr 16, 2025

View reviewed changes

johnny94 mentioned this pull request Apr 16, 2025

MINOR: Remove Kafka release section from root README #19483

Merged


		./gradlew processMessages processTestMessages

		See [Apache Kafka Message Definitions](/clients/src/main/resources/common/message/README.md) for details on Apache Kafka message protocol


		### Using Trogdor for testing ###

		We Trogdor as a test framework for Apache Kafka. You can use it to run benchmarks and other workloads.


		docker run -p 9092:9092 apache/kafka:3.7.0

		See [docker/README.md] for detailed information.

		@@ -30,8 +30,8 @@ Building image and running tests using github actions
		- kafka-url - This is the url to download kafka tarball from. For example kafka tarball url from (https://archive.apache.org/dist/kafka). For building RC image this will be an RC tarball url.


		See [vagrant/README.md](vagrant/README.md).

		### Release Kafka ###

Conversation

johnny94 commented Apr 9, 2025 • edited by chia7712 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

frankvicky left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

johnny94 Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Yunyung left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

m1a2st left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

johnny94 commented Apr 9, 2025 •

edited by chia7712

Loading

johnny94 Apr 9, 2025 •

edited

Loading