DOC-1809 Document Cloud Feature Group-based Access Control via OIDC#536
DOC-1809 Document Cloud Feature Group-based Access Control via OIDC#536
Conversation
📝 WalkthroughWalkthroughThis pull request introduces Group-Based Access Control (GBAC) documentation to the Redpanda documentation site. The changes include switching the Antora content source branch from Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
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 docstrings
🧪 Generate unit tests (beta)
Comment |
✅ 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: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@local-antora-playbook.yml`:
- Around line 17-18: Update the branches list for the repository URL entry so it
no longer points at the temporary gbac branch: replace the branches array that
currently includes "gbac" (branches: [gbac, v/*, shared, site-search]) with one
that uses "main" instead (branches: [main, v/*, shared, site-search]) to ensure
production builds use the main branch before merging; locate the branches array
under the URL entry for https://github.com/redpanda-data/documentation to make
this change.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1d62f042-2641-4e77-9128-08f8de569313
📒 Files selected for processing (5)
local-antora-playbook.ymlmodules/ROOT/nav.adocmodules/get-started/pages/whats-new-cloud.adocmodules/security/pages/authorization/cloud-authorization.adocmodules/security/pages/authorization/gbac.adoc
| - url: https://github.com/redpanda-data/documentation | ||
| branches: [main, v/*, shared, site-search] | ||
| branches: [gbac, v/*, shared, site-search] |
There was a problem hiding this comment.
Reminder: Revert branch to main before merging.
The gbac branch is used here for local preview rendering while the corresponding docs PR (redpanda-data/docs#1584) is in progress. Per the cross-repository single-sourcing pattern, this should be reverted to main before merging so the production build continues to work correctly.
- url: https://github.com/redpanda-data/documentation
- branches: [gbac, v/*, shared, site-search]
+ branches: [main, v/*, shared, site-search]Based on learnings: "The playbook is reverted to main before merging. This cross-repository single sourcing pattern is commonly used."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - url: https://github.com/redpanda-data/documentation | |
| branches: [main, v/*, shared, site-search] | |
| branches: [gbac, v/*, shared, site-search] | |
| - url: https://github.com/redpanda-data/documentation | |
| branches: [main, v/*, shared, site-search] |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@local-antora-playbook.yml` around lines 17 - 18, Update the branches list for
the repository URL entry so it no longer points at the temporary gbac branch:
replace the branches array that currently includes "gbac" (branches: [gbac, v/*,
shared, site-search]) with one that uses "main" instead (branches: [main, v/*,
shared, site-search]) to ensure production builds use the main branch before
merging; locate the branches array under the URL entry for
https://github.com/redpanda-data/documentation to make this change.
1 participant
Description
This pull request single sources GBAC in Redpanda Cloud from redpanda-data/docs#1584. The changes add a GBAC doc page, update navigation and references throughout the docs, and highlight the feature in the "What's New" section.
gbac.adocdetailing how to configure and use Group-Based Access Control (GBAC) with OIDC groups, including learning objectives and configuration steps.nav.adoc) to include a direct link to the new GBAC page under the security authorization section.Antora Playbook Update:
local-antora-playbook.ymlfrommaintogbacto ensure the new GBAC documentation is included.Resolves https://redpandadata.atlassian.net/browse/DOC-1809
Review deadline:
Page previews
What's New
Configure Group-Based Access Control
Cloud Authorization
Checks