Skip to content

Conversation

@paulohtb6
Copy link
Collaborator

Description

Resolves https://redpandadata.atlassian.net/browse/
Review deadline:

Page previews

Checks

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

@paulohtb6 paulohtb6 requested a review from a team as a code owner December 12, 2025 14:59
@paulohtb6 paulohtb6 requested a review from r-vasquez December 12, 2025 14:59
@netlify
Copy link

netlify bot commented Dec 12, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 41aac9e
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/693c70340cd40d0008a99090
😎 Deploy Preview https://deploy-preview-1515--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.

@paulohtb6 paulohtb6 requested a review from micheleRP December 12, 2025 14:59
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Dec 12, 2025

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This PR updates reference documentation across multiple rpk command pages. The changes add new flag descriptions (including --no-confirm, --timeout, --kafka-connections-limit, --iotune-path, --for-cloud, and --format), improve formatting consistency by wrapping default/example values in backticks, add Kubernetes-specific annotations to flag entries, and include new guidance text for Redpanda Cloud operations (login instructions, cluster selection, and ID reference behavior). No code functionality is altered—only documentation text and reference tables are updated.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

The review spans 10 different documentation files with primarily repetitive changes (adding flag descriptions to tables and updating prose), but the breadth and need to verify accuracy of each description entry, consistency of formatting, and correctness of Kubernetes-specific annotations warrant moderate effort. Areas of particular attention:

  • Cross-file consistency in flag description formats and Kubernetes annotations (rpk-debug-bundle.adoc vs rpk-debug-remote-bundle-start.adoc for --kafka-connections-limit)
  • Accuracy of default values and examples (e.g., timeout defaults, --iotune-path default, format options)
  • Consistency of backtick formatting for code values across files
  • Completeness and clarity of new guidance text for Redpanda Cloud workflows

Possibly related PRs

Suggested reviewers

  • kbatuigas
  • r-vasquez

Pre-merge checks and finishing touches

❌ Failed checks (1 warning, 1 inconclusive)
Check name Status Explanation Resolution
Description check ⚠️ Warning The pull request description is incomplete, with the template placeholders unfilled (JIRA ticket URL, review deadline, page previews) and no checkboxes selected to indicate the type of change. Complete the description by filling in the JIRA ticket URL, review deadline, adding page preview links, and selecting at least one checkbox to categorize the changes made.
Title check ❓ Inconclusive The title 'rpk: update reference with dec 12th' is vague and non-descriptive, using generic language that doesn't clearly convey the specific changes made to the rpk reference documentation. Improve the title to specifically mention the primary changes, such as 'rpk: add flags and documentation updates for cluster config, debug, iotune, and shadow commands' or similar descriptive wording.
✅ Passed checks (1 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

Copy link
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: 6

🧹 Nitpick comments (8)
modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc (1)

46-49: Align default formatting style for --timeout with other flag rows.
Most rows use (default \...`); this one ends with “Default 10s`.” Consider switching to the same pattern for consistency.

modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc (1)

30-31: Keep --kafka-connections-limit wording/notes consistent with rpk debug bundle (and capitalize “Kafka”).
If you add a Kubernetes support note in one page, mirror it in the other to avoid conflicting guidance.

modules/reference/pages/rpk/rpk-iotune.adoc (1)

42-44: Clarify what “after --” refers to in --timeout description.
If this means “after starting the iotune process”, say that explicitly; if it refers to the CLI -- parsing sentinel, consider spelling out “after the -- separator” to remove ambiguity.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc (1)

69-71: Consider making --config default search paths platform-aware (macOS/Windows vs Linux).

Right now this reads Linux-only; we’ve previously documented macOS has a different default path. Based on learnings, please align this boilerplate with the platform-specific paths used elsewhere.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc (2)

6-7: Please verify --for-cloud exists and document what it changes (if non-obvious).

At minimum, ensure rpk shadow config generate --help matches this flag name and description; if it alters specific fields/defaults, a short callout would reduce confusion.

Also applies to: 56-57


64-67: Consider making --config default search paths platform-aware (macOS/Windows vs Linux).

Same boilerplate appears here and may be misleading off Linux. Based on learnings, align with the platform-specific paths used elsewhere.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc (1)

49-52: Consider making --config default search paths platform-aware (macOS/Windows vs Linux).

Same boilerplate appears here and may be misleading off Linux. Based on learnings, align with the platform-specific paths used elsewhere.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc (1)

51-54: Consider making --config default search paths platform-aware (macOS/Windows vs Linux).

Same boilerplate appears here and may be misleading off Linux. Based on learnings, align with the platform-specific paths used elsewhere.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between e7f9623 and 80e03f5.

📒 Files selected for processing (10)
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-set.adoc (1 hunks)
  • modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc (1 hunks)
  • modules/reference/pages/rpk/rpk-debug/rpk-debug-remote-bundle-start.adoc (1 hunks)
  • modules/reference/pages/rpk/rpk-iotune.adoc (1 hunks)
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc (2 hunks)
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc (1 hunks)
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc (1 hunks)
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc (1 hunks)
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc (1 hunks)
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc (2 hunks)
🧰 Additional context used
🧠 Learnings (4)
📓 Common learnings
Learnt from: kbatuigas
Repo: redpanda-data/docs PR: 1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax `+` and `--` around content blocks within a `[tabs]` section are valid AsciiDoc formatting elements for tabbed content. The `+` after a tab name (like `rpk::`) indicates that the following block belongs to that tab, and the `--` markers enclose the content for that tab. These are not diff artifacts and should not be removed.
📚 Learning: 2025-11-25T09:42:15.235Z
Learnt from: CR
Repo: redpanda-data/docs PR: 0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-11-25T09:42:15.235Z
Learning: Always include the `--cloud-support` flag when running doc-tools CLI to generate property documentation - never exclude it

Applied to files:

  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc
📚 Learning: 2025-05-07T01:06:00.937Z
Learnt from: kbatuigas
Repo: redpanda-data/docs PR: 1113
File: modules/manage/partials/iceberg/use-iceberg-catalogs.adoc:100-107
Timestamp: 2025-05-07T01:06:00.937Z
Learning: In AsciiDoc documentation for Redpanda, the syntax `+` and `--` around content blocks within a `[tabs]` section are valid AsciiDoc formatting elements for tabbed content. The `+` after a tab name (like `rpk::`) indicates that the following block belongs to that tab, and the `--` markers enclose the content for that tab. These are not diff artifacts and should not be removed.

Applied to files:

  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config-generate.adoc
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc
📚 Learning: 2025-09-16T13:51:26.524Z
Learnt from: JakeSCahill
Repo: redpanda-data/docs PR: 1358
File: modules/reference/partials/rpk-cloud/rpk-cloud-mcp-proxy.adoc:57-63
Timestamp: 2025-09-16T13:51:26.524Z
Learning: rpk config file search paths are platform-specific: macOS uses "~/Library/Application Support/rpk/rpk.yaml" while Linux uses "/var/lib/redpanda/.config/rpk/rpk.yaml". The documentation should account for platform differences rather than assuming Linux-only paths.

Applied to files:

  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Redirect rules - redpanda-docs-preview
  • GitHub Check: Header rules - redpanda-docs-preview
  • GitHub Check: Pages changed - redpanda-docs-preview
🔇 Additional comments (5)
modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc (1)

123-126: --namespace Kubernetes-only annotation is clear and consistent.
This matches the page’s Kubernetes section and helps avoid confusion in non-k8s deployments.

modules/reference/pages/rpk/rpk-iotune.adoc (1)

34-35: --iotune-path addition is clear and nicely documents the default.
No issues with the flag row formatting.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-list.adoc (1)

21-22: Please verify rpk shadow list --format values/default match the current CLI help output.

Docs look consistent, but this needs to be exact (supported values + default) to avoid breaking users.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc (1)

12-12: Terminology update to “shadow cluster” reads clearer/consistent.

modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc (1)

41-42: Please verify rpk shadow status --format values/default match the current CLI help output.

Comment on lines 102 to 106
|--kafka-connections-limit |int |The maximum number of kafka connections to store in the bundle. Default `256`.

|-l, --label-selector |stringArray |Comma-separated label selectors to filter your resources. e.g: <label>=<value>,<label>=<value> (k8s only) (default ` [app.kubernetes.io/name=redpanda]`).

|--logs-since |string |Include logs dated from specified date onward. This flag accepts a `journalctl` date format such as `YYYY-MM-DD`, `yesterday`, or `today`. Refer to the link:https://man7.org/linux/man-pages/man1/journalctl.1.html[`journalctl` documentation] for more options (default `yesterday`).
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Clarify Kubernetes applicability + capitalize “Kafka” in --kafka-connections-limit description.
Right now the row doesn’t say whether it’s supported in Kubernetes, while other flags explicitly call that out; also “kafka” → “Kafka”.

🤖 Prompt for AI Agents
In modules/reference/pages/rpk/rpk-debug/rpk-debug-bundle.adoc around lines 102
to 106, update the --kafka-connections-limit row to capitalize “Kafka” and
explicitly state Kubernetes applicability to match other flags (e.g., append
“(k8s only)” or “(Kubernetes only)” if it only applies to k8s); keep the
existing type, description and default value but reword the description to:
mention it’s the maximum number of Kafka connections stored in the bundle and
add the Kubernetes scope note in the same style as nearby flag rows.

Comment on lines 27 to 31
|--duration |duration |Duration of tests.The value passed is a sequence
of decimal numbers, each with optional fraction and a unit suffix, such
as `300ms`, `1.5s` or `2h45m`. Valid time units are `ns`, `us` (or
`µs`), `ms`, `s`, `m`, `h` (default 10m0s).
`µs`), `ms`, `s`, `m`, `h` (default `10m0s`).

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix minor typo in --duration description (“tests.The” → “tests. The”).
Pure doc polish, but it’s user-facing in a reference table.

🤖 Prompt for AI Agents
In modules/reference/pages/rpk/rpk-iotune.adoc around lines 27 to 31, there is a
minor punctuation typo in the --duration description ("tests.The" should be
"tests. The"); update the text to insert a space after the period so the
sentence reads "Duration of tests. The value passed is a sequence..." and keep
the rest of the wording and formatting unchanged.

Comment on lines 10 to 11
When creating a Shadow Link for Redpanda Cloud, make sure to login and select the cluster where you want to create the Shadow Link before running this command. See xref:reference:rpk/rpk-cloud/rpk-cloud-login.adoc[`rpk cloud login`] and xref:reference:rpk/rpk-cloud/rpk-cloud-select.adoc[`rpk cloud select`]. For SCRAM authentication, store your password in the secrets store. See xref:reference:rpk/rpk-security/rpk-security-secret.adoc[`rpk security secret --help`] for more details.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, find the referenced documentation files to verify they exist
fd rpk-security-secret modules/reference/pages/

Repository: redpanda-data/docs

Length of output: 44


🏁 Script executed:

# Search for SCRAM and secrets store guidance in Cloud-related docs
rg -i "scram|secrets store|password" modules/reference/pages/rpk/rpk-cloud/ --type adoc

Repository: redpanda-data/docs

Length of output: 90


🏁 Script executed:

# Check for existing Cloud login guidance to see consistent phrasing
rg "log in|login" modules/reference/pages/rpk/rpk-cloud/ --type adoc -A 2 -B 2

Repository: redpanda-data/docs

Length of output: 90


🏁 Script executed:

# Find other instances of "make sure to login" or "make sure to log in"
rg "make sure to (log in|login)" modules/reference/pages/rpk/ --type adoc

Repository: redpanda-data/docs

Length of output: 90


🏁 Script executed:

# Check rpk-shadow-create.adoc file itself to see full context
cat -n modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc | head -60

Repository: redpanda-data/docs

Length of output: 2758


🏁 Script executed:

# Find rpk-security-secret documentation
fd rpk-security-secret modules/reference/pages/

Repository: redpanda-data/docs

Length of output: 44


🏁 Script executed:

# Search for SCRAM in Cloud docs using glob
rg -i "scram" modules/reference/pages/rpk/rpk-cloud/

Repository: redpanda-data/docs

Length of output: 140


🏁 Script executed:

# Search for "secrets store" guidance in docs
rg -i "secrets store" modules/reference/pages/rpk/

Repository: redpanda-data/docs

Length of output: 609


🏁 Script executed:

# Check for "log in" (correct form) vs "login" (incorrect form) in Cloud docs
rg "log in" modules/reference/pages/rpk/rpk-cloud/

Repository: redpanda-data/docs

Length of output: 140


🏁 Script executed:

# Also check broader rpk docs for "log in" pattern
rg "log in" modules/reference/pages/rpk/ | head -20

Repository: redpanda-data/docs

Length of output: 44


🏁 Script executed:

# List the rpk directory structure
ls -la modules/reference/pages/rpk/ | head -30

Repository: redpanda-data/docs

Length of output: 1460


🏁 Script executed:

# Search for rpk-security files anywhere in the repo
fd rpk-security modules/

Repository: redpanda-data/docs

Length of output: 1663


🏁 Script executed:

# Search for any SCRAM mentions in the entire docs
rg -i "scram" modules/

Repository: redpanda-data/docs

Length of output: 38000


🏁 Script executed:

# Search for "login" as verb form in docs (current usage)
rg '"login"' modules/reference/pages/rpk/ | head -20

Repository: redpanda-data/docs

Length of output: 44


🏁 Script executed:

# Check usage of "login" or "log in" in context
rg "to login|to log in|login and select|log in and select" modules/reference/pages/rpk/

Repository: redpanda-data/docs

Length of output: 609


🏁 Script executed:

# Check the rpk-security-secret documentation
cat -n modules/reference/partials/rpk-security/rpk-security-secret.adoc

Repository: redpanda-data/docs

Length of output: 1034


🏁 Script executed:

# Search for Cloud-specific documentation
find modules -type d -name "*cloud*" 2>/dev/null

Repository: redpanda-data/docs

Length of output: 98


🏁 Script executed:

# Look for shadow link setup guidance in manage docs
cat -n modules/manage/pages/disaster-recovery/shadowing/setup.adoc | grep -A 10 -B 10 -i "scram\|secret\|password"

Repository: redpanda-data/docs

Length of output: 5361


🏁 Script executed:

# Check if there are any rpk cloud reference files
fd rpk-cloud modules/reference/

Repository: redpanda-data/docs

Length of output: 1127


🏁 Script executed:

# Search for any guidance on storing passwords or secrets in context of rpk
rg -i "store.*password|password.*store|secrets store" modules/manage/pages/disaster-recovery/shadowing/ -A 3 -B 3

Repository: redpanda-data/docs

Length of output: 44


🏁 Script executed:

# Check the rpk-cloud-login.adoc for login/log in guidance
cat -n modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc

Repository: redpanda-data/docs

Length of output: 2970


🏁 Script executed:

# Search for any mention of "secrets" or "secret store" in rpk-cloud docs
rg -i "secret|password" modules/reference/partials/rpk-cloud/

Repository: redpanda-data/docs

Length of output: 1406


🏁 Script executed:

# Check if there's any Cloud-specific auth guidance about storing credentials
rg -i "store.*credential|credential.*store|secret.*password" modules/reference/partials/rpk-cloud/

Repository: redpanda-data/docs

Length of output: 44


Change "login" to "log in" (phrasal verb form).

The phrase "make sure to login" should be "make sure to log in" — this is the correct verb form for the phrasal verb, not the noun form. This inconsistency also appears in rpk-cloud-login.adoc, which uses both forms ("Log in to Redpanda Cloud" in the title, but "rpk will use the SSO method to login" in the body).

Regarding the SCRAM/secrets-store guidance: I could not find documentation in the codebase confirming that storing passwords in the secrets store is required for Cloud shadow links with SCRAM authentication. The shadowing setup documentation shows SCRAM credentials configured directly in the shadow link configuration file, not stored separately in a secrets store. Please verify whether this guidance is specific to Redpanda Cloud shadow links or if it should be removed or clarified.

🤖 Prompt for AI Agents
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc around lines 10 to
11: change the incorrect noun form "login" to the phrasal verb "log in" in the
sentence "make sure to log in and select the cluster..." (also search the
related rpk-cloud-login.adoc for mixed usage and make it consistent). Also
verify the SCRAM guidance: confirm whether Redpanda Cloud shadow links require
storing SCRAM passwords in the secrets store; if not, remove or reword the
sentence to accurately reflect the supported configuration (either state that
SCRAM credentials can be provided directly in the shadow link config or
explicitly reference the exact Cloud-specific secret-store requirement and link
to the authoritative docs).

Comment on lines 10 to 11
For Redpanda Cloud, `rpk` will use the Redpanda ID of the cluster you are currently logged into. If you wish to use a different one either login and create a profile for it, or use the `--redpanda-id` flag to specify it directly.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, locate the file and check the exact wording
find . -name "rpk-shadow-describe.adoc" -type f

Repository: redpanda-data/docs

Length of output: 127


🏁 Script executed:

# Search for similar documentation and "login" vs "log in" usage patterns in the codebase
rg "log[in]" --type adoc -i | head -20

Repository: redpanda-data/docs

Length of output: 90


🏁 Script executed:

# Look for rpk shadow describe documentation or help information
fd -e adoc -e md -e txt | xargs grep -l "shadow describe" 2>/dev/null | head -10

Repository: redpanda-data/docs

Length of output: 312


🏁 Script executed:

# Search for Redpanda Cloud documentation patterns related to authentication
rg "Redpanda Cloud.*rpk" --type adoc -A 2 | head -30

Repository: redpanda-data/docs

Length of output: 90


🏁 Script executed:

# Read the target file to verify the exact wording and context
cat -n modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc | head -30

Repository: redpanda-data/docs

Length of output: 1265


🏁 Script executed:

# Search for "login" vs "log in" patterns across documentation
rg "log\s?in" --no-filename | grep -i "redpanda\|cloud\|rpk" | head -20

Repository: redpanda-data/docs

Length of output: 3153


🏁 Script executed:

# Search more broadly for login/log in patterns
rg "(login|log in)" | head -30

Repository: redpanda-data/docs

Length of output: 4754


🏁 Script executed:

# Check the rpk-cloud-login documentation to understand the Cloud behavior
cat -n modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc | head -50

Repository: redpanda-data/docs

Length of output: 1955


🏁 Script executed:

# Search for --redpanda-id flag documentation
rg "\-\-redpanda-id" -A 3 -B 1

Repository: redpanda-data/docs

Length of output: 1739


🏁 Script executed:

# Look for rpk shadow create to see if it has the same issue
cat -n modules/reference/pages/rpk/rpk-shadow/rpk-shadow-create.adoc | grep -A 3 -B 3 "login"

Repository: redpanda-data/docs

Length of output: 1067


Fix grammar: change "login and create" to "log in and create".

The phrase uses the verb form of "log in" (two words), not the noun "login" (one word). This same issue appears in related Shadow documentation (rpk-shadow-create.adoc) and rpk cloud login documentation.

The described behavior—using the currently logged-in Redpanda Cloud cluster's ID by default and allowing override via --redpanda-id flag—aligns with rpk's Cloud authentication model.

🤖 Prompt for AI Agents
In modules/reference/pages/rpk/rpk-shadow/rpk-shadow-describe.adoc around lines
10-11, change the incorrect noun "login" to the verb form "log in" in the phrase
"login and create a profile" so it reads "log in and create a profile"; also
apply the same correction in the related files (rpk-shadow-create.adoc and the
rpk cloud login docs) where "login and create" appears to ensure consistent
grammar across the documentation.

Failover a Redpanda shadow link.

This command performs a failover operation for a shadow link. Failover converts shadow topics into regular topics on the destination cluster, allowing producers and consumers to interact with them directly. After failover, the shadow link stops replicating data from the source cluster.
This command performs a failover operation for a shadow link. Failover converts shadow topics into regular topics on the shadow cluster, allowing producers and consumers to interact with them directly. After failover, the shadow link stops replicating data from the source cluster.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix typo: double space in “shadow cluster”.

Change “shadow cluster” → “shadow cluster”.

🤖 Prompt for AI Agents
In modules/reference/pages/rpk/rpk-shadow/rpk-shadow-failover.adoc around line
6, there's a typo with a double space in the phrase "shadow  cluster"; replace
the double space with a single space so it reads "shadow cluster".

Comment on lines 8 to 9
By default, the command displays all status sections. Use the flags to display specific sections such as overview, task status, or topic status. When using this command with the --format json/yaml flag, `rpk` defaults to all sections.

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

cat -n modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc | head -60

Repository: redpanda-data/docs

Length of output: 2321


🏁 Script executed:

# Also search for any examples or help text related to rpk shadow status
rg "rpk shadow status" -A 3 -B 3

Repository: redpanda-data/docs

Length of output: 11286


🏁 Script executed:

# Check if there's documentation about --format behavior
rg "\-\-format" modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc -B 2 -A 2

Repository: redpanda-data/docs

Length of output: 761


Remove redundant phrasing about default sections with --format.

Line 8 states "By default, the command displays all status sections" then immediately repeats this with "When using this command with the --format json/yaml flag, rpk defaults to all sections." Consolidate to avoid confusion. If the --format flag affects only output formatting (not which sections display), clarify that the --print-* flags control section selection across all formats. If format does affect section selection, specify which sections appear with each format.

🤖 Prompt for AI Agents
modules/reference/pages/rpk/rpk-shadow/rpk-shadow-status.adoc lines 8-9: the
text redundantly states the default sections twice and is unclear about whether
--format affects which sections are shown; consolidate the sentences into one
clear statement that says "By default the command displays all status sections;
use the --print-*" flags to select specific sections (overview, task status,
topic status) and the --format json|yaml flag only changes output format, not
which sections are included" (or if behavior differs, explicitly list which
sections each format includes); update the line to remove duplication and ensure
it clearly attributes section selection to --print-* and formatting to --format.

Copy link
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.

Thanks Paulo: please see suggestions!

|===
|*Value* |*Type* |*Description*

|--for-cloud |- |Generate configuration suitable for Redpanda Cloud.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we conditionalize this?

|-h, --help |- |Display documentation for `rpk debug bundle`.

|--kafka-connections-limit |int |The maximum number of Kafka connections to store in the bundle. Default `256`.
|--kafka-connections-limit |int |The maximum number of Kafka connections to store in the bundle (k8s only). Default `256`.
Copy link
Contributor

Choose a reason for hiding this comment

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

suggest Kubernetes only
similar to the other instance of it on that page

Copy link
Contributor

@r-vasquez r-vasquez left a comment

Choose a reason for hiding this comment

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

Thanks!

@paulohtb6 paulohtb6 merged commit 467f2ff into main Dec 12, 2025
7 checks passed
@paulohtb6 paulohtb6 deleted the update-rpk-reference branch December 12, 2025 19:57
@coderabbitai coderabbitai bot mentioned this pull request Dec 16, 2025
4 tasks
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.

5 participants