Add rpk cloud auth token reference partial#1723
Conversation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThis pull request adds a new AsciiDoc documentation partial for the Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 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 docstrings
🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
🧹 Nitpick comments (1)
modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc (1)
4-4: ⚡ Quick winUse empty brackets in xref to auto-pull the document title.
The xref link has hard-coded text
[Authenticate to Redpanda SQL]. Per repository conventions, prefer using empty brackets[]to automatically pull the title from the referenced document when publishing.♻️ Suggested fix
-The `rpk cloud auth token` command prints the auth token for the currently selected cloud authentication to stdout. This is useful for piping the token into other commands or scripts that need to authenticate with Redpanda Cloud. For an example, see xref:sql:connect-to-sql/authenticate.adoc[Authenticate to Redpanda SQL]. +The `rpk cloud auth token` command prints the auth token for the currently selected cloud authentication to stdout. This is useful for piping the token into other commands or scripts that need to authenticate with Redpanda Cloud. For an example, see xref:sql:connect-to-sql/authenticate.adoc[].Based on learnings: "AsciiDoc linking: prefer using xref links with empty brackets (e.g., xref:section/target.adoc[]) because the title is pulled from the referenced document automatically. Avoid hard-coding link text; use xref:...[] to let the target document's title render as the link text when publishing."
🤖 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 `@modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc` at line 4, Replace the hard-coded xref text in the rpk-cloud-auth-token.adoc sentence: locate the xref reference "xref:sql:connect-to-sql/authenticate.adoc[Authenticate to Redpanda SQL]" and change it to use empty brackets so the target document's title is pulled automatically (i.e., use xref:sql:connect-to-sql/authenticate.adoc[]).
🤖 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.
Nitpick comments:
In `@modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc`:
- Line 4: Replace the hard-coded xref text in the rpk-cloud-auth-token.adoc
sentence: locate the xref reference
"xref:sql:connect-to-sql/authenticate.adoc[Authenticate to Redpanda SQL]" and
change it to use empty brackets so the target document's title is pulled
automatically (i.e., use xref:sql:connect-to-sql/authenticate.adoc[]).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 0d28dca6-4320-41db-9ffd-6311212063fc
📒 Files selected for processing (1)
modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc
Description
This pull request adds documentation for the
rpk cloud auth tokencommand, providing details on its usage, flags, and purpose. The documentation explains how to retrieve the current authentication token for Redpanda Cloud and describes the available command-line options.New documentation:
rpk-cloud-auth-token.adoc, documenting therpk cloud auth tokencommand, its usage, and available flags.Resolves https://redpandadata.atlassian.net/browse/
Review deadline:
Page previews
https://deploy-preview-605--rp-cloud.netlify.app/cloud-data-platform/reference/rpk/rpk-cloud/rpk-cloud-auth-token/
Checks