docs(ui): web interface updates: users, deleting committed offsets#2351
docs(ui): web interface updates: users, deleting committed offsets#2351PaulRMellor merged 6 commits intostreamshub:mainfrom
Conversation
Signed-off-by: prmellor <pmellor@redhat.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the StreamsHub Console documentation to describe new Kafka Users pages and adds the delete committed offsets feature for resetting consumer offsets. The updates also include editorial improvements for clarity and consistency across multiple concept and procedure documentation files.
Changes:
- Added documentation for Kafka Users pages, including viewing user authentication details and authorization rules (ACLs)
- Documented the new "Delete committed offsets" option when resetting consumer offsets, with appropriate warnings
- Added documentation for checking Kafka Connect connectors and clusters
- Editorial improvements to overview, navigation, and cluster monitoring documentation for better clarity and conciseness
Reviewed changes
Copilot reviewed 8 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/sources/modules/proc-resetting-consumer-offsets.adoc | Added documentation for the new "Delete committed offsets" option with important cautionary note |
| docs/sources/modules/proc-checking-users.adoc | New procedure file documenting how to check Kafka user authentication and authorization details |
| docs/sources/modules/proc-checking-topic-messages.adoc | Editorial change: "dropdown" → "dropdown menu" for consistency |
| docs/sources/modules/proc-checking-connectors.adoc | New procedure file documenting how to check Kafka Connect connector status and configuration |
| docs/sources/modules/proc-checking-connect-clusters.adoc | New procedure file documenting how to check Kafka Connect cluster details |
| docs/sources/modules/con-using-the-console.adoc | Editorial rewrite for improved clarity and conciseness |
| docs/sources/modules/con-users-page.adoc | New concept file describing the Kafka Users page and the information it displays |
| docs/sources/modules/con-navigating-the-console.adoc | Added Kafka Users to the list of console pages; editorial improvements for clarity |
| docs/sources/modules/con-cluster-overview-page.adoc | Enhanced metrics documentation with details about interactive charts and time range options |
| docs/sources/index.adoc | Added includes for new Kafka Users and updated Kafka Connect documentation files |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: prmellor <pmellor@redhat.com>
MikeEdgar
left a comment
There was a problem hiding this comment.
Looks good, thanks @PaulRMellor . There is just one suggestion.
Signed-off-by: prmellor <pmellor@redhat.com>
|
Thanks @MikeEdgar |
Signed-off-by: prmellor <pmellor@redhat.com>
|



Documentation
Updates the console guide.
Note: The following doc updates are not covered:
These will be covered in separate PRs