rpk cloud auth token reference#605
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for rp-cloud 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:
📝 WalkthroughWalkthroughThis PR adds a new reference documentation page for the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![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 current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@local-antora-playbook.yml`:
- Line 18: The branches list contains a non-standard branch entry
'DOC-2218-add-reference-for-rpk-cloud-auth-token' which fails branch validation;
edit the branches array (the "branches" key in local-antora-playbook.yml) to
replace that offending ref with an allowed branch (e.g., main) so the entry
becomes a valid ref among the existing items (ensure the rest of the list
elements like v/*, shared, site-search remain unchanged).
🪄 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: 342d3455-9739-4c64-9427-e831b5733964
📒 Files selected for processing (6)
local-antora-playbook.ymlmodules/ROOT/nav.adocmodules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adocmodules/sql/pages/connect-to-sql/authenticate.adocmodules/sql/pages/get-started/deploy-sql-cluster.adocmodules/sql/pages/get-started/sql-quickstart.adoc
| branches: HEAD | ||
| - url: https://github.com/redpanda-data/documentation | ||
| branches: [main, v/*, shared, site-search] | ||
| branches: ['DOC-2218-add-reference-for-rpk-cloud-auth-token', v/*, shared, site-search] |
There was a problem hiding this comment.
Revert non-standard branch in playbook to pass branch validation.
This line introduces a branch value that violates the allowed branch policy and is already failing CI (check-branches). Replace it with an allowed ref (typically main) for mergeable config.
Suggested fix
- branches: ['DOC-2218-add-reference-for-rpk-cloud-auth-token', v/*, shared, site-search]
+ branches: [main, v/*, shared, site-search]📝 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.
| branches: ['DOC-2218-add-reference-for-rpk-cloud-auth-token', v/*, shared, site-search] | |
| branches: [main, v/*, shared, site-search] |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@local-antora-playbook.yml` at line 18, The branches list contains a
non-standard branch entry 'DOC-2218-add-reference-for-rpk-cloud-auth-token'
which fails branch validation; edit the branches array (the "branches" key in
local-antora-playbook.yml) to replace that offending ref with an allowed branch
(e.g., main) so the entry becomes a valid ref among the existing items (ensure
the rest of the list elements like v/*, shared, site-search remain unchanged).
2 participants
Description
Related: redpanda-data/docs#1723
This pull request adds documentation for the new
rpk cloud auth tokencommand and updates related references throughout the documentation. The main changes include creating a dedicated reference page for the command, updating the navigation, and ensuring that relevant guides link to the new documentation.Documentation additions and updates:
rpk cloud auth tokencommand atmodules/reference/pages/rpk/rpk-cloud/rpk-cloud-auth-token.adoc.modules/ROOT/nav.adocto include the newrpk-cloud-auth-tokenreference.modules/sql/pages/connect-to-sql/authenticate.adocto link to the new reference page forrpk cloud auth token.modules/sql/pages/get-started/sql-quickstart.adocandmodules/sql/pages/get-started/deploy-sql-cluster.adoc) to reference the newrpk cloud auth tokendocumentation when instructing users to retrieve a temporary authentication token.Build configuration:
local-antora-playbook.ymlto use the correct branch (DOC-2218-add-reference-for-rpk-cloud-auth-token) for the documentation source, ensuring the new reference page is included in local builds.Resolves https://github.com/redpanda-data/documentation-private/issues/
Review deadline:
Page previews
Checks