DOC-1732: Document managing Schema Registry ACLs in Console#1769
Conversation
Add a Console UI procedure for Schema Registry subject and registry ACLs to the single-sourced schema-reg-authorization.adoc, and note the Subject and Schema Registry resource types in the Add ACL modal in acl.adoc. Both pages single-source to cloud-docs, so this covers Cloud and self-managed. Verified the Add ACL Resource Type labels (Subject, Schema Registry) against a live Console build. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
📝 WalkthroughWalkthroughAdded Schema Registry ACL documentation for the UI. The new section explains how to manage ACLs from the Security page, choose Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Feediver1
left a comment
There was a problem hiding this comment.
PR Review (final-pass against docs-team-standards)
Files reviewed: 2 .adoc files
Overall assessment: Clean, well-scoped doc-gap fill. Prose follows the style guide, the new xref reuses an existing precedent that already builds in both repos, and impact on other files is minimal. No blocking issues — only a few optional refinements.
Jira ticket alignment
DOC-1732 — Addresses the stated gap precisely: showing the Add ACL Resource Type list includes the SR types, with a worked example. Resource Type labels verified against a live Console build per the PR body. Scope matches; no gaps.
Critical issues (must fix)
None. The new xref:manage:schema-reg/schema-reg-authorization.adoc[] in acl.adoc reuses the same pattern already at acl.adoc:140, so it resolves in both docs and cloud-docs. {ui} resolves from antora.yml (ui: Redpanda Console@, overridable in cloud-docs). Everything renders.
Suggestions (should consider)
-
[schema-reg-authorization.adoc:40] Now-stale redirect. The self-managed bullet says "...use {ui} to manage Schema Registry ACLs. See
xref:manage:security/authorization/acl.adoc[]." — but there's now a richer local section ~13 lines below. Consider pointing this bullet at the new local section (xref:#manage-schema-registry-acls-in-redpanda-console[]) so readers aren't bounced toacl.adocand back. -
[schema-reg-authorization.adoc:62] "see the Supported operations table below" — an anchored xref (
xref:#supported-operations[Supported operations]) is more robust than prose "below" and consistent with the rest of the page. -
[schema-reg-authorization.adoc:55] "After Schema Registry Authorization is enabled..." reads slightly off for the Cloud render, where authorization is on by default (per DOC-1936). The statement is still true, but the conditional framing implies an enabling step Cloud readers don't take. Optional env-gate or reword.
-
[schema-reg-authorization.adoc:53] Heading style consistency: sibling H3 is "How to manage Schema Registry Authorization"; the new one is imperative ("Manage..."). Both valid sentence case — just noting the slight pattern drift.
Impact on other files
- nav.adoc: No change needed — page already in nav (
nav.adoc:214); new subsection, not a new page. - What's New: No entry needed — fills a gap in an existing feature (SR Authorization, v25.2).
- Inbound xrefs: 12+ pages xref
schema-reg-authorization.adoc; all remain valid (only a section was added, nothing renamed/moved).
What works well
- Single-source-safe: new xref reuses the proven pattern at
acl.adoc:140, so no cross-repo build risk. - Cross-page consistency: Subject / Schema Registry Resource Type labels match between both edited pages.
- Strong, concrete worked example (Subject / Literal /
sensor-data-value/ Read / Allow). - Active voice, second person, present tense, no em dashes throughout.
- Bidirectional cross-linking keeps both entry points discoverable.
🤖 Generated with Claude Code
Feediver1
left a comment
There was a problem hiding this comment.
Check out the suggestions
Address Feediver1 review feedback: - Link the Console method bullet to the new in-page section via an explicit [#manage-sr-acls-console] anchor instead of bouncing to acl.adoc - Drop the "After ... is enabled" conditional from the section intro so it reads correctly in the Cloud render (authorization is on by default) - Remove the redundant pointer to the Supported operations table (it sits directly below); keep the [#supported-operations] ID for existing inbound links Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Summary
Documents how to manage Schema Registry ACLs (subject and registry resource types) through the Redpanda Console UI. Both edited pages carry
// tag::single-source[], so this content lands in both self-managed docs and Cloud with no separate cloud-docs PR needed.modules/manage/pages/schema-reg/schema-reg-authorization.adoc— newManage Schema Registry ACLs in Consolesection: how to reach ACLs on a user/role detail page, that the Add ACL modal's Resource Type offers Subject and Schema Registry, and a worked subject-ACL example (Subject / Literal /sensor-data-value/ Read / Allow).modules/manage/pages/security/authorization/acl.adoc— one line on the+ Add ACLbullet noting Resource Type includes Subject and Schema Registry for Schema Registry ACLs, with an xref to the SR authorization page.Context
DOC-1732 was ~80% covered already:
subject/registrypermissions).The gap was that nothing showed the Add ACL Resource Type list includes the Schema Registry types, with a worked example. This PR fills it.
The Resource Type labels (Subject, Schema Registry) were verified against a live Console build.
This also covers the Console-UI portion of DOC-1866 (self-managed sibling), since the edited pages are single-sourced.
Preview pages
Test plan
xref:manage:schema-reg/schema-reg-authorization.adoc[]resolves in both repos).docs-team-standards:revieweditorial pass.🤖 Generated with Claude Code