DOC-1637 update cloud for SR auth UI #396
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 📝 WalkthroughWalkthroughThe PR updates documentation navigation and a page title/metadata. In modules/ROOT/nav.adoc, the ACLs entry is moved under Security > Authorization as its own third-level item, no longer nested under RBAC. The previous ACL link under the RBAC subtree is removed. In modules/security/pages/authorization/rbac/acl.adoc, the page title is shortened from "Use ACLs in the Data Plane" to "Use ACLs," and a description metadata line is added. The include directive remains unchanged. Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Assessment against linked issues
Assessment against linked issues: Out-of-scope changes
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
✅ Deploy Preview for rp-cloud ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
modules/security/pages/authorization/rbac/acl.adoc (1)
1-2: Optional: consider future path move to reflect new IANow that ACLs aren’t nested under RBAC in nav, the file path
security/pages/authorization/rbac/acl.adocis a mild mismatch. Not urgent, but consider relocating tosecurity/pages/authorization/acl.adocin a future IA cleanup, with:page-aliases:to preserve inbound links.+= Use ACLs +:page-aliases: security:authorization/rbac/acl.adoc :description: Learn how to use ACLs to configure fine-grained access to Redpanda resources.modules/ROOT/nav.adoc (1)
60-60: Nit: consider an expanded nav label for clarityIf space allows, “Access control lists (ACLs)” can help first-time readers. If brevity is preferred (consistent with “RBAC”), keep as-is.
-*** xref:security:authorization/rbac/acl.adoc[ACLs] +*** xref:security:authorization/rbac/acl.adoc[Access control lists (ACLs)]
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
modules/ROOT/nav.adoc(1 hunks)modules/security/pages/authorization/rbac/acl.adoc(1 hunks)
🔇 Additional comments (4)
modules/security/pages/authorization/rbac/acl.adoc (2)
1-2: Title simplification + description meta look goodRenamed heading and added
:description:are aligned with the new nav label and improve SEO/snippets. No issues.
1-2: Verify cross-repo include target and tag in the docs repoIt looks like the include source
modules/manage/pages/security/authorization/acl.adocisn’t present in this cloud-docs repo—per our single-sourcing pattern, that file (and its[tag=single-source]marker) should live in the docs repo. Please confirm:
- In the corresponding PR on the docs repository, there is a file at
modules/manage/pages/security/authorization/acl.adoc
and it contains thetag=single-sourceattribute on the include block.- The local-antora-playbook.yml used for preview properly links that docs PR so the include resolves.
modules/ROOT/nav.adoc (2)
60-60: Correctly relocated ACLs out of RBAC subtreeThe new third-level entry
xref:security:authorization/rbac/acl.adoc[ACLs]under Authorization fulfills DOC-1637 (ACLs no longer nested under RBAC). Order alongside “Cloud Authorization” and the RBAC index looks consistent.
60-60: ACLs xref in modules/ROOT/nav.adoc is singular and resolves correctly
- Found one
xref:security/authorization/rbac/acl.adoc[ACLs]entry in modules/ROOT/nav.adoc (line 60).- Target file modules/security/pages/authorization/rbac/acl.adoc exists and is reachable.
- No legacy “Use ACLs in the Data Plane” entries detected in nav.adoc.
Description
This pull request updates the nav structure for ACLs in the security authorization section.
Related to redpanda-data/docs#1334
Resolves https://redpandadata.atlassian.net/browse/DOC-1637
Review deadline:
Page previews
Authorization index page
Checks