Skip to content

docs: re-render rpk docs for overrides change (main) - #1876

Closed
vbotbuildovich wants to merge 1 commit into
mainfrom
rpk-docs/overrides-rerender-main
Closed

docs: re-render rpk docs for overrides change (main)#1876
vbotbuildovich wants to merge 1 commit into
mainfrom
rpk-docs/overrides-rerender-main

Conversation

@vbotbuildovich

Copy link
Copy Markdown
Contributor

Automated re-render of the generated rpk reference pages after an overrides change on main (f4308f9).

Review focus: the changed pages should reflect exactly the merged overrides edit, nothing else. The generator version is pinned to the same range the release regeneration uses, so unrelated churn here means the branch missed a regeneration and this PR is catching it up.

rpk Documentation Generation Summary

Version: v26.2.1

Generation Statistics

Metric Count
Commands documented 361
Files generated 355
Files skipped (excluded) 6

Curated descriptions replacing source help

These overrides replace substantially longer help text from the rpk source. Confirm the curated version still carries every operational detail (or intentionally omits it):

Command Override Source help
rpk topic consume 159 chars 9372 chars
rpk topic produce 137 chars 6181 chars
rpk security acl 1543 chars 5912 chars
rpk debug bundle 244 chars 3442 chars
rpk group delete 244 chars 983 chars
rpk cluster config 292 chars 991 chars
rpk topic describe 216 chars 748 chars

Validation Report

Severity Count
⚠️ Warnings 1
Issues by Rule
  • duplicate-content: 1 warnings

Generated by rpk-docs automation

@vbotbuildovich
vbotbuildovich requested a review from a team as a code owner August 3, 2026 10:23
@vbotbuildovich vbotbuildovich added automated documentation Improvements or additions to documentation rpk labels Aug 3, 2026
@netlify

netlify Bot commented Aug 3, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

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

Copy link
Copy Markdown
Contributor

Closing: this rerender was generated with the published doc-tools 5.3.2 and would revert the corrections that just merged in #1875 (page-wrapper removal, summary fixes, corrected introduced-in versions, and the two curation-wins content fixes), which were produced with the fixes on docs-extensions-and-macros#241. Once #241 releases, the first rerender reproduces main's current state byte for byte and this branch goes quiet.

@JakeSCahill JakeSCahill closed this Aug 3, 2026
@coderabbitai

coderabbitai Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: a2fa925e-118b-4ece-9999-7a01ebb66df9

📥 Commits

Reviewing files that changed from the base of the PR and between f4308f9 and 65297a3.

📒 Files selected for processing (57)
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-brokers.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-edit.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-export.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-force-reset.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-import.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-lint.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config-status.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-config.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-health.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license-set.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-license.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-loggers.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-maintenance.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-disable.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-enable.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions-list.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-partitions.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas-alter.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-quotas.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-self-test.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-storage-restore.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn-list.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-txn.adoc
  • modules/reference/pages/rpk/rpk-cluster/rpk-cluster-upgrade.adoc
  • modules/reference/pages/rpk/rpk-generate/rpk-generate-grafana-dashboard.adoc
  • modules/reference/pages/rpk/rpk-generate/rpk-generate-license.adoc
  • modules/reference/pages/rpk/rpk-generate/rpk-generate-prometheus-config.adoc
  • modules/reference/pages/rpk/rpk-generate/rpk-generate.adoc
  • modules/reference/pages/rpk/rpk-profile/rpk-profile-prompt.adoc
  • modules/reference/pages/rpk/rpk-profile/rpk-profile-validate.adoc
  • modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config-set.adoc
  • modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-config.adoc
  • modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-mode.adoc
  • modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune-list.adoc
  • modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-tune.adoc
  • modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda.adoc
  • modules/reference/pages/rpk/rpk-registry/rpk-registry-mode-set.adoc
  • modules/reference/pages/rpk/rpk-registry/rpk-registry-mode.adoc
  • modules/reference/pages/rpk/rpk-registry/rpk-registry-schema-get.adoc
  • modules/reference/pages/rpk/rpk-registry/rpk-registry-schema.adoc
  • modules/reference/pages/rpk/rpk-shadow/rpk-shadow-config.adoc
  • modules/reference/pages/rpk/rpk-topic/rpk-topic-analyze.adoc
  • modules/reference/pages/rpk/rpk-topic/rpk-topic-describe-storage.adoc
  • modules/reference/pages/rpk/rpk-topic/rpk-topic-trim-prefix.adoc
  • modules/reference/pages/rpk/rpk-topic/rpk-topic.adoc
  • modules/reference/pages/rpk/rpk-transform/rpk-transform-logs.adoc
  • modules/reference/pages/rpk/rpk-transform/rpk-transform-pause.adoc
  • modules/reference/pages/rpk/rpk-transform/rpk-transform-resume.adoc
  • modules/reference/pages/rpk/rpk-transform/rpk-transform.adoc
  • modules/reference/partials/rpk-ai/rpk-ai-install.adoc
  • modules/reference/partials/rpk-ai/rpk-ai-version.adoc
  • modules/reference/partials/rpk-cloud/rpk-cloud-byoc-install.adoc
  • modules/reference/partials/rpk-cloud/rpk-cloud-byoc-uninstall.adoc
  • modules/reference/partials/rpk-cloud/rpk-cloud-byoc.adoc
  • modules/reference/partials/rpk-cloud/rpk-cloud-login.adoc
  • modules/reference/partials/rpk-cloud/rpk-cloud-logout.adoc
  • modules/reference/partials/rpk-cloud/rpk-cloud.adoc

Disabled knowledge base sources:

  • Jira integration is disabled

You can enable these sources in your CodeRabbit configuration.


📝 Walkthrough

Walkthrough

The PR updates generated RPK reference documentation across cluster, generate, profile, Redpanda, registry, topic, transform, AI, and cloud commands. It adds env-cloud guards to exclude self-hosted documentation from cloud builds. It expands command descriptions with syntax, behavior, configuration, storage, and credential details. It also updates AsciiDoc formatting and a profile prompt example.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

Suggested reviewers: feediver1, jakescahill

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch rpk-docs/overrides-rerender-main

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated documentation Improvements or additions to documentation rpk

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants