docs: fix partition IDs and auto commit wording in the README quickstart - #4040
Merged
Merged
Conversation
The quickstart described a topic with 2 partitions as having IDs 1 and 2, sent to --partition-id 1 and polled partition 1. Stream, topic and partition IDs are assigned starting from 0, so a topic created with 2 partitions has partitions 0 and 1. Use partition 0 throughout. Also says "the first message" and "a second message" rather than "message ID 1" and "message ID 2", which read as a claim about server-assigned IDs when they only meant the first and second example.
The poll example described itself as "without auto commit (storing consumer offset on server)" while the command passes --auto-commit. The parenthetical describes what auto commit does, so the prose was the half that was wrong. --auto-commit is documented in the CLI as "whether to commit offset on the server automatically after polling the messages", which is what the example intends to show.
|
Thanks for the PR. It is labeled Slash commands (own line, regular comment) move it around the queue:
See CONTRIBUTING.md for details. |
justinmclean
changed the title
justinmclean
changed the title
krishvishal
approved these changes
Sep 3, 2026
hubcio
approved these changes
Sep 3, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
Which issue does this PR address?
N/A
Rationale
The quickstart tells a new user to use partition 1 on a topic whose partitions are 0 and 1, and describes a poll as running without auto commit while passing
--auto-commit. It is the first thing a newcomer runs.What changed?
The quickstart said a topic created with 2 partitions has "IDs 1 and 2", then sent to
--partition-id 1and polled partition 1. Stream, topic and partition IDs are assigned starting from 0, so that topic has partitions 0 and 1, and the example was addressing the second partition while describing it as the first. It now uses partition 0 throughout.The poll example described itself as "without auto commit (storing consumer offset on server)" while passing
--auto-commit."(message ID 1)" and "(message ID 2)" become "the first message" and "a second message" — same meaning, without reading as a claim about server-assigned IDs.
Local Execution
core/integration/tests/data_integrity/verify_consumer_group_partition_assignment.rs, which creates a topic with 3 partitions and sends to0..PARTITIONS_COUNT, and against the Concepts and Architecture pages ("assigned from 0"). The--auto-commitwording was checked against the CLI's own help text.AI Usage
Yes I used claude, in a Cowork session. All changes reviewed by a human.