Skip to content

preview: Remove token structure examples from Cloud GBAC docs#553

Closed
micheleRP wants to merge 1 commit intomainfrom
fix/remove-token-examples-from-cloud-gbac-preview
Closed

preview: Remove token structure examples from Cloud GBAC docs#553
micheleRP wants to merge 1 commit intomainfrom
fix/remove-token-examples-from-cloud-gbac-preview

Conversation

@micheleRP
Copy link
Copy Markdown
Contributor

Summary

⚠️ Revert playbook change before merge — or close this PR after review.

Preview pages

Self-managed preview (from docs#1669 — unchanged)

🤖 Generated with Claude Code

Temporarily override the docs repo branch to
fix/remove-token-examples-from-cloud-gbac so the Netlify
deploy preview shows the Cloud GBAC pages without the
token structure examples section.

⚠️ Revert before merge.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@micheleRP micheleRP requested a review from a team as a code owner April 14, 2026 20:06
@netlify
Copy link
Copy Markdown

netlify bot commented Apr 14, 2026

Deploy Preview for rp-cloud ready!

Name Link
🔨 Latest commit dbf7587
🔍 Latest deploy log https://app.netlify.com/projects/rp-cloud/deploys/69de9e59decb4a000899b23c
😎 Deploy Preview https://deploy-preview-553--rp-cloud.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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 14, 2026

📝 Walkthrough

Walkthrough

This pull request updates the Antora playbook configuration file to change the branch used for pulling documentation content from the redpanda-data/documentation repository. The main branch is replaced with fix/remove-token-examples-from-cloud-gbac in the branches list, while other branch patterns (v/*, shared, and site-search) remain unchanged. This directs the documentation build to source content from the specified feature branch instead of the primary branch.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

Suggested reviewers

  • JakeSCahill
🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description deviates significantly from the template structure and lacks critical required sections like issue reference, review deadline, and checkbox selections. Add the required template sections: issue link, review deadline, page preview links in the correct format, and check the appropriate box for 'Small fix' category.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: pointing the playbook to a branch that removes token examples from Cloud GBAC documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/remove-token-examples-from-cloud-gbac-preview

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

Copy link
Copy Markdown
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: 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`:
- Line 18: The playbook's branches array currently contains a preview-only
feature branch in the "branches" entry (branches:
[fix/remove-token-examples-from-cloud-gbac, v/*, shared, site-search]) which
triggers the CI policy failure; update the "branches" configuration to point
back to the canonical branch (e.g., replace the feature branch entry with main)
or move this preview override into a CI-excluded playbook file, and ensure the
preview-only override is reverted to main before merging so the `Check playbook
branches` policy no longer fails.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d7634625-cdc6-42eb-8b65-95c253a34231

📥 Commits

Reviewing files that changed from the base of the PR and between d56a2d4 and dbf7587.

📒 Files selected for processing (1)
  • local-antora-playbook.yml

Comment thread local-antora-playbook.yml
branches: HEAD
- url: https://github.com/redpanda-data/documentation
branches: [main, v/*, shared, site-search]
branches: [fix/remove-token-examples-from-cloud-gbac, v/*, shared, site-search]
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Preview branch override currently breaks required CI policy.

Line 18 intentionally points to a feature branch for preview, but this triggers the Check playbook branches failure (Non-standard branch reference found) and leaves the PR non-mergeable. Keep this for preview-only validation, then revert to main before merge (or close the PR after review), or move preview-only overrides to a CI-excluded playbook file.

Suggested revert before merge
-    branches: [fix/remove-token-examples-from-cloud-gbac, v/*, shared, site-search]
+    branches: [main, v/*, shared, site-search]

Based on learnings: this cross-repo preview override pattern is expected, and the playbook is reverted to main before merging.

📝 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.

Suggested change
branches: [fix/remove-token-examples-from-cloud-gbac, v/*, shared, site-search]
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` at line 18, The playbook's branches array
currently contains a preview-only feature branch in the "branches" entry
(branches: [fix/remove-token-examples-from-cloud-gbac, v/*, shared,
site-search]) which triggers the CI policy failure; update the "branches"
configuration to point back to the canonical branch (e.g., replace the feature
branch entry with main) or move this preview override into a CI-excluded
playbook file, and ensure the preview-only override is reverted to main before
merging so the `Check playbook branches` policy no longer fails.

@micheleRP
Copy link
Copy Markdown
Contributor Author

closing as this was only necessary for preview in docs

@micheleRP micheleRP closed this Apr 15, 2026
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.

1 participant