justinmclean opened a new pull request, #4040:
URL: https://github.com/apache/iggy/pull/4040
## 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 1` and 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
- Passed — documentation only, no code paths changed and nothing to execute.
The partition numbering was checked against
`core/integration/tests/data_integrity/verify_consumer_group_partition_assignment.rs`,
which creates a topic with 3 partitions and sends to `0..PARTITIONS_COUNT`,
and against the Concepts and Architecture pages ("assigned from 0"). The
`--auto-commit` wording 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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
