Skip to content

docs: update rpk CLI documentation (v26.2.1-rc2) - #1831

Open
github-actions[bot] wants to merge 3 commits into
betafrom
rpk-docs-v26.2.1-rc2
Open

docs: update rpk CLI documentation (v26.2.1-rc2)#1831
github-actions[bot] wants to merge 3 commits into
betafrom
rpk-docs-v26.2.1-rc2

Conversation

@github-actions

@github-actions github-actions Bot commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Summary

Automated update of rpk CLI documentation.

Version: v26.2.1-rc2

rpk Documentation Generation Summary

Version: v26.2.1-rc2

Generation Statistics

Metric Count
Commands documented 356
Files generated 351
Files skipped (excluded) 5

Validation Report

✅ All files passed validation.

Generated by rpk-docs automation

Automation

Generated by rpk-docs automation.

Review the changes and merge when ready.

@github-actions
github-actions Bot requested a review from a team as a code owner July 27, 2026 13:43
@github-actions github-actions Bot added documentation Improvements or additions to documentation automated labels Jul 27, 2026
@netlify

netlify Bot commented Jul 27, 2026 •
edited
Loading

Copy link
Copy Markdown

✅ Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 046e02f
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a677b5893952000087249a3
😎 Deploy Preview https://deploy-preview-1831--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.

@JakeSCahill
JakeSCahill marked this pull request as draft July 27, 2026 14:39
@JakeSCahill

JakeSCahill commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Do not merge as-is: this deletes the rpk k8s reference pages that ship with 26.2 GA.

The multicluster commands (bootstrap/status/bundle) are not part of the rpk core binary at any version. They come from the separately published k8s managed plugin. This regen ran during the pre-GA window, when the automation's rpk k8s install step finds no plugin to install: the plugin publisher's stableVersionRe only promotes pure X.Y.Z versions to latest, and only 26.2.1-beta.3 exists today. With the plugin absent from the command tree, the generator treats the rpk-k8s pages as stale and removes them. The generator's own plugin-install code documents this exact case as expected pre-GA behavior, not a generator bug.

Plan: hold this PR until the GA k8s plugin publishes (the unpinned rpk k8s install resolving is already on the GA-day checklist), then rerun the automation — the rpk k8s pages regenerate and the rest of the rc2/GA updates come along. A generator guard is also going in so a failed plugin install can never delete that plugin's existing pages again.

@JakeSCahill JakeSCahill mentioned this pull request Jul 27, 2026
Open
@JakeSCahill
docs: restore plugin-provided rpk pages and summarize CLI changes
0c9e976 
The k8s plugin's pages (multicluster bootstrap/bundle/status and
version) and the ai plugin partials were deleted because the
generation environment has no plugin installed, and the GA k8s plugin
is not published until the 26.2 operator releases. Restore them and
their nav entries, along with the root rpk.adoc nav entry the regen
dropped. The rpk redpanda admin removals stand: the command group is
deprecated in 26.2 in favor of rpk cluster.

Also add a Redpanda CLI section to the What's New page covering the
new rpk cluster upgrade commands, the rpk redpanda admin deprecation,
and the new k8s and check managed plugins.

The generator-side fix that prevents plugin-page deletion is
docs-extensions-and-macros#221.
@JakeSCahill
JakeSCahill marked this pull request as ready for review July 27, 2026 15:28
@JakeSCahill

JakeSCahill commented Jul 27, 2026

Copy link
Copy Markdown
Contributor

Restored the plugin-provided pages directly on this branch so it can merge before GA: the five rpk k8s pages (multicluster bootstrap/bundle/status, multicluster root, version), the two rpk ai partials, their nav entries, and the root rpk.adoc nav entry the regen dropped. The rpk redpanda admin page and nav removals stand: that command group is deprecated in 26.2 in favor of rpk cluster (per the deprecation scanner, with brokers/loggers/upgrade now under rpk cluster).

Also added a Redpanda CLI (rpk) section to the What's New page summarizing 26.2 CLI changes: the new rpk cluster upgrade status/finalize commands (deferred finalization), the rpk redpanda admin deprecation, and the new k8s and check managed plugins.

Generator-side prevention is in docs-extensions-and-macros#221: plugin subtrees that are absent or shim-only in a run's tree can no longer have their pages deleted. After the GA plugin publishes, the next scheduled regen will regenerate the k8s pages from the real plugin instead of these restored copies.

@JakeSCahill
docs: add page aliases for moved rpk commands and fix a malformed page
046e02f 
- The rpk redpanda admin brokers list and admin partitions pages are
  removed in this release because the commands moved to rpk cluster.
  Add page aliases on rpk cluster info and rpk cluster partitions so
  the old URLs redirect, and persist the aliases in the rpk overrides
  so regeneration keeps them.
- Expand the What's New entry: name each command's new home, per the
  deprecation notices that rpk itself prints, and state that the old
  commands keep working in this release as deprecated aliases.
  Verified against the v26.2.1-rc2 binary.
- Fence the sample output in rpk cluster brokers decommission-status
  as literal blocks. The command help's ASCII underlines rendered as
  an unterminated example block delimiter.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

automated documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@JakeSCahill