Skip to content

docs(ui): web interface updates: users, deleting committed offsets#2351

Merged
PaulRMellor merged 6 commits intostreamshub:mainfrom
PaulRMellor:docs_ui-doc-changes
Mar 2, 2026
Merged

docs(ui): web interface updates: users, deleting committed offsets#2351
PaulRMellor merged 6 commits intostreamshub:mainfrom
PaulRMellor:docs_ui-doc-changes

Conversation

@PaulRMellor
Copy link
Contributor

@PaulRMellor PaulRMellor commented Feb 24, 2026

Documentation

Updates the console guide.

  • Describes new Kafka users pages
  • Adds the delete committed offsets option for resetting offsets
  • Some editorial review updates

Note: The following doc updates are not covered:

  • Forthcoming UI name change: Consumer groups -> Groups
  • Description of group types (consumer, share, streams)
  • Kroxy virtual clusters
  • Config/deploy changes

These will be covered in separate PRs

Signed-off-by: prmellor <pmellor@redhat.com>
@PaulRMellor PaulRMellor added this to the 0.11.1 milestone Feb 24, 2026
@PaulRMellor PaulRMellor requested review from a team and MikeEdgar February 24, 2026 16:03
@PaulRMellor PaulRMellor self-assigned this Feb 24, 2026
Copilot AI review requested due to automatic review settings February 24, 2026 16:03
@PaulRMellor PaulRMellor added the documentation Improvements or additions to documentation label Feb 24, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Copy link
Member

@MikeEdgar MikeEdgar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks @PaulRMellor . There is just one suggestion.

@PaulRMellor
Copy link
Contributor Author

Thanks @MikeEdgar
Updated as suggested

Signed-off-by: prmellor <pmellor@redhat.com>
@sonarqubecloud
Copy link

sonarqubecloud bot commented Mar 2, 2026

@PaulRMellor PaulRMellor merged commit eafb972 into streamshub:main Mar 2, 2026
7 checks passed
@PaulRMellor PaulRMellor deleted the docs_ui-doc-changes branch March 2, 2026 16:16
@MikeEdgar MikeEdgar modified the milestones: 0.11.1, 0.12.0 Mar 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants