Skip to content

Conversation

@Feediver1
Copy link
Contributor

@Feediver1 Feediver1 commented Oct 27, 2025

Description

Resolves https://redpandadata.atlassian.net/browse/DOC-1772
Review deadline: Tuesday, October 28th, 2025

Page previews

https://deploy-preview-1420--redpanda-docs-preview.netlify.app/current/manage/security/authorization/rbac/#manage-roles

Checks

  • New feature
  • Content gap
  • Support Follow-up
  • [X ] Small fix (typos, links, copyedits, etc)

@Feediver1 Feediver1 requested a review from a team as a code owner October 27, 2025 21:07
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 27, 2025

📝 Walkthrough

Walkthrough

This PR corrects an invalid ACL create command example in the RBAC documentation. The topic patterns in the example are updated from analytics-* and reports-* to analytics- and reports-, respectively, by removing the explicit wildcards. Since the --resource-pattern-type prefixed flag implies prefix matching behavior, the wildcard character is redundant and was causing validation failures when running the command.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

  • Single documentation file modified (modules/manage/partials/rbac-dp.adoc)
  • Minimal, straightforward text corrections to example commands
  • No logic or structural changes

Possibly related PRs

Suggested reviewers

  • andresaristizabal
  • r-vasquez
  • micheleRP

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (4 passed)
Check name Status Explanation
Linked Issues Check ✅ Passed The PR changes directly address the core objective from linked issue DOC-1772, which identified an invalid ACL create command due to invalid topic naming. The issue reported that the command failed with validation errors when using 'analytics-' as the topic pattern with --resource-pattern-type prefixed. The PR correctly implements the suggested fix by removing the wildcard suffix from the topic names ('analytics-' becomes 'analytics-' and 'reports-' becomes 'reports-'), which aligns with the issue's finding that the '' is implied by the prefixed pattern type and causes validation failures.
Out of Scope Changes Check ✅ Passed The PR introduces changes only to the file modules/manage/partials/rbac-dp.adoc, with modifications focused exclusively on correcting the topic pattern syntax in the ACL command example. All changes are directly related to resolving the documented issue of invalid ACL command syntax, and there are no incidental modifications to unrelated files, code sections, or content areas. The changes remain narrowly scoped to the specific problem identified in DOC-1772.
Title Check ✅ Passed The PR title "DOC-1772: Fix invalid ACL command example in RBAC documentation" directly aligns with the changeset. The pull request modifies a single file (rbac-dp.adoc) in the RBAC documentation section, updating an ACL command example to fix invalid topic name patterns that were failing Kafka validation. The title clearly identifies what is being fixed (the invalid ACL command example) and where (RBAC documentation), making it specific and actionable for reviewers scanning the change history.
Description Check ✅ Passed The pull request description follows the required template structure and includes all essential sections: a Description section with a Jira ticket link (DOC-1772) and review deadline, a Page previews section with a Netlify preview URL pointing to the relevant documentation page, and a Checks section with "Small fix" appropriately marked. The classification as a small fix aligns with the actual changes, which involve correcting an invalid ACL command example in the RBAC documentation by removing wildcard suffixes from topic names. All required template fields are populated with relevant information, making the description complete and adequate for understanding the scope and purpose of the change.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch Feediver1-patch-3

Comment @coderabbitai help to get the list of available commands and usage tips.

@Feediver1 Feediver1 requested a review from JFlath October 27, 2025 21:08
@netlify
Copy link

netlify bot commented Oct 27, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit ebc419f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/69025b84489b4b00083eae69
😎 Deploy Preview https://deploy-preview-1420--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (1)
modules/manage/partials/rbac-dp.adoc (1)

189-189: Update best practice example to reflect corrected pattern format.

The best practice statement references analytics-* as a prefixed pattern, but the corrected command examples now use analytics- (without wildcard) when paired with --resource-pattern-type prefixed. Clarify the guidance to reflect that the prefix itself (e.g., analytics-) is sufficient and the wildcard is redundant with the prefixed flag.

Apply this diff to align the best practice with the corrected examples:

-* Use wildcards carefully: Prefixed patterns like `analytics-*` are useful but review regularly
+* Use wildcards carefully: Prefixed patterns (e.g., `analytics-` with `--resource-pattern-type prefixed`) match topics by prefix and should be reviewed regularly
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between a829416 and 4a1ff83.

📒 Files selected for processing (1)
  • modules/manage/partials/rbac-dp.adoc (2 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: 2025-08-25T21:00:26.626Z
Learnt from: micheleRP
PR: redpanda-data/docs#1334
File: modules/manage/partials/rbac-dp.adoc:93-98
Timestamp: 2025-08-25T21:00:26.626Z
Learning: In cloud documentation (env-cloud), Security is at the top level navigation, so ACL references should use `security:authorization/rbac/acl.adoc`. In self-managed documentation, Security is nested under Manage, so ACL references use `manage:security/authorization/acl.adoc`. The different xref paths in conditional blocks reflect these different navigation structures.

Applied to files:

  • modules/manage/partials/rbac-dp.adoc
🔇 Additional comments (2)
modules/manage/partials/rbac-dp.adoc (2)

37-44: Corrected ACL commands now conform to Kafka topic naming validation.

Removing the wildcard suffix (*) from the topic patterns aligns with the semantics of --resource-pattern-type prefixed, which already implies prefix matching. The corrected patterns (analytics- and reports-) are now valid and will execute without validation errors.


158-158: Verify consistency of resource pattern type usage in rpk acl examples.

The corrected examples at lines 37–43 use explicit --resource-pattern-type prefixed flags with prefix patterns ('analytics-', 'reports-'), while the self-managed example at line 158 uses a wildcard pattern (private-*) without this flag. Additionally, the narrative text at line 189 references analytics-* with an asterisk, but the actual command uses 'analytics-' without one.

Clarify whether:

  • The wildcard syntax private-* at line 158 works without --resource-pattern-type, or if it should also include the flag for consistency
  • The distinction between prefix patterns ('topic-') and wildcard patterns (topic-*) has different requirements

@Feediver1 Feediver1 changed the title DOC-1772: Update rbac-dp.adoc DOC-1772: Fix invalid ACL command example in RBAC documentation Oct 29, 2025
@Feediver1 Feediver1 merged commit 4e72eb9 into main Oct 29, 2025
5 checks passed
@Feediver1 Feediver1 deleted the Feediver1-patch-3 branch October 29, 2025 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants