Skip to content

Add rpk cloud auth token reference partial#1723

Merged
kbatuigas merged 1 commit into
mainfrom
DOC-2218-add-reference-for-rpk-cloud-auth-token
May 29, 2026
Merged

Add rpk cloud auth token reference partial#1723
kbatuigas merged 1 commit into
mainfrom
DOC-2218-add-reference-for-rpk-cloud-auth-token

Conversation

@kbatuigas
Copy link
Copy Markdown
Contributor

@kbatuigas kbatuigas commented May 29, 2026

Description

This pull request adds documentation for the rpk cloud auth token command, 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:

  • Added a new partial, rpk-cloud-auth-token.adoc, documenting the rpk cloud auth token command, 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

  • New feature
  • Content gap
  • Support Follow-up
  • Small fix (typos, links, copyedits, etc)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@kbatuigas kbatuigas requested a review from a team as a code owner May 29, 2026 17:23
@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit bbb2367
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a19cb82beaac4000866bb94
😎 Deploy Preview https://deploy-preview-1723--redpanda-docs-preview.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 May 29, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

This pull request adds a new AsciiDoc documentation partial for the rpk cloud auth token command. The file documents the command's purpose (printing the currently selected cloud authentication token), provides usage syntax, and lists all supported flags including --help, --config, -X/--config-opt, --profile, and -v/--verbose. The content is wrapped in single-source tags for templating compatibility.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested reviewers

  • JakeSCahill
  • r-vasquez
  • Feediver1
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and directly describes the main change: adding a new AsciiDoc partial documenting the rpk cloud auth token command.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description check ✅ Passed The PR description follows the template structure with all major sections included, though some placeholder values remain unfilled.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch DOC-2218-add-reference-for-rpk-cloud-auth-token

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.

🧹 Nitpick comments (1)
modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc (1)

4-4: ⚡ Quick win

Use 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

📥 Commits

Reviewing files that changed from the base of the PR and between 7b6420c and bbb2367.

📒 Files selected for processing (1)
  • modules/reference/partials/rpk-cloud/rpk-cloud-auth-token.adoc

Copy link
Copy Markdown
Contributor

@micheleRP micheleRP left a comment

Choose a reason for hiding this comment

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

lgtm!

@kbatuigas kbatuigas merged commit 3a47b9f into main May 29, 2026
7 checks passed
@kbatuigas kbatuigas deleted the DOC-2218-add-reference-for-rpk-cloud-auth-token branch May 29, 2026 18:55
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.

3 participants