MINOR: Add missing streams groups tools doc #21248
Conversation
github-actions
bot
added
triage
|
Thanks, LGTM! |
lucasbru
changed the title
There was a problem hiding this comment.
Pull request overview
This PR restores the kafka-streams-groups tool documentation that was accidentally removed in a previous commit. It adds comprehensive documentation for the kafka-streams-groups.sh CLI tool and updates a reference link to point to the restored documentation.
Key Changes:
- Adds complete documentation file for the Kafka Streams Groups tool (
kafka-streams-group-sh.md) - Updates link format in
app-reset-tool.mdto correctly reference the restored documentation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/streams/developer-guide/kafka-streams-group-sh.md | New comprehensive documentation file for the kafka-streams-groups.sh CLI tool, covering usage, commands, options, and best practices |
| docs/streams/developer-guide/app-reset-tool.md | Updates link reference to the restored Streams groups CLI documentation with corrected anchor format |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| --- | ||
| title: Kafka Streams Groups Tool | ||
| type: docs | ||
| description: |
There was a problem hiding this comment.
The description field in the front matter is empty. Consider adding a brief description of what this page covers, which can be useful for SEO and search functionality within the documentation site.
| description: | |
| description: CLI reference for `kafka-streams-groups.sh` to list, describe, reset offsets, and delete Kafka Streams groups using the Streams Rebalance Protocol (KIP‑1071). |
|
|
||
| * `--list`: List Streams groups. Use `--state` to display/filter by state. | ||
| * `--describe`: Describe a group selected by `--group`. Combine with: | ||
| * `--state` (group state and epochs), `--members` (members and assignments), `--offsets` (input and repartition topics offsets/lag). |
There was a problem hiding this comment.
Grammatical inconsistency: should be either 'input and repartition topic offsets/lag' (singular) or 'input and repartition topics' offsets/lag' (with apostrophe for possessive). The current phrasing 'topics offsets/lag' is grammatically incorrect.
| * `--state` (group state and epochs), `--members` (members and assignments), `--offsets` (input and repartition topics offsets/lag). | |
| * `--state` (group state and epochs), `--members` (members and assignments), `--offsets` (input and repartition topic offsets/lag). |
Added usage instructions for kafka-streams-groups.sh.
4 participants
This was accidentally removed in
78bc9486be671fffa5bb499d5aacdd25e8f29296
Reviewers: Lucas Brutschy [email protected]