Remove token structure examples from Cloud GBAC docs#1669
Conversation
The token structure examples reference cluster properties (oidc_group_claim_path, nested_group_behavior) that Cloud users don't configure directly. Cloud users configure group claim extraction through SSO connection settings in the Cloud UI, which is already documented separately in the Cloud-specific ifdef block. Co-Authored-By: Claude Opus 4.6 (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:
📝 WalkthroughWalkthroughThe documentation file for GBAC token claim extraction was updated to conditionally exclude the "Token structure examples" section from cloud environment builds. An Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
modules/manage/partials/gbac-token-claim-extraction.adoc (1)
56-67: Remove redundant nestedifndef::env-cloud[]inside already gated block.Since
Line 24already gates the full section for non-Cloud builds, the innerifndef::env-cloud[]block adds unnecessary nesting.♻️ Suggested simplification
-// Not supported in Cloud -ifndef::env-cloud[] ==== Path-style group names with suffix extraction When xref:reference:properties/cluster-properties.adoc#nested_group_behavior[`nested_group_behavior`] is set to `suffix`, Redpanda maps the last path segment to principals `Group:platform` and `Group:infra`. [,json] ---- {"groups": ["/departments/eng/platform", "/departments/eng/infra"]} ---- -endif::[]🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@modules/manage/partials/gbac-token-claim-extraction.adoc` around lines 56 - 67, The inner conditional block `ifndef::env-cloud[]` is redundant because the whole section is already gated for non-Cloud builds; remove the nested `ifndef::env-cloud[]`/`endif::[]` wrapper around the "Path-style group names with suffix extraction" subsection so the header, the `nested_group_behavior` reference, and the JSON example (["/departments/eng/platform", "/departments/eng/infra"]) remain directly inside the outer non-Cloud guard; ensure only the outer guard remains so the subsection renders unchanged for non-Cloud builds.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@modules/manage/partials/gbac-token-claim-extraction.adoc`:
- Around line 56-67: The inner conditional block `ifndef::env-cloud[]` is
redundant because the whole section is already gated for non-Cloud builds;
remove the nested `ifndef::env-cloud[]`/`endif::[]` wrapper around the
"Path-style group names with suffix extraction" subsection so the header, the
`nested_group_behavior` reference, and the JSON example
(["/departments/eng/platform", "/departments/eng/infra"]) remain directly inside
the outer non-Cloud guard; ensure only the outer guard remains so the subsection
renders unchanged for non-Cloud builds.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: a385140c-be06-4782-8ed2-c97e3f3e07e1
📒 Files selected for processing (1)
modules/manage/partials/gbac-token-claim-extraction.adoc
The outer ifndef on line 24 already gates the entire token structure examples section from Cloud, making the inner guard around the suffix extraction subsection unnecessary. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary
ifndef::env-cloud[]in thegbac-token-claim-extraction.adocpartialWhy
The token structure examples reference cluster properties (
oidc_group_claim_path,nested_group_behavior) that Cloud users don't configure directly. This content is confusing for Cloud customers, who configure group claim extraction through SSO connection settings in the Cloud UI.Preview pages
Self-managed (unchanged — examples still present)
Cloud (changed — examples removed)
Cloud preview via companion PR: redpanda-data/cloud-docs#553 (⚠️ close after merge)
Test plan
🤖 Generated with Claude Code