Skip to content

docs: migrate stale rpk ai llm overrides to the renamed command - #1858

Closed
JakeSCahill wants to merge 1 commit into
mainfrom
cleanup/stale-rpk-ai-llm-overrides
Closed

docs: migrate stale rpk ai llm overrides to the renamed command#1858
JakeSCahill wants to merge 1 commit into
mainfrom
cleanup/stale-rpk-ai-llm-overrides

Conversation

@JakeSCahill

Copy link
Copy Markdown
Contributor

Summary

Flagged in review on docs-extensions-and-macros#225: every rpk docs regeneration prints override validation errors for rpk ai llm and rpk ai llm check — the rpai plugin renamed llmllm-provider, so those entries silently do nothing.

  • The provider-type note moves to rpk ai llm-provider (with openai-compatible added, matching the plugin's current config groups).
  • The llm check description override is dropped: the renamed command's own help ("Runs a lightweight probe against the upstream to verify credentials and reachability") already covers it.

The remaining two validation errors (rpk cluster storage restore-start, rpk connect studio sync-schema) are left for their owners to triage — this PR only handles the rename casualties.

Related: the generator now surfaces these validation errors in automated PR bodies (docs-extensions-and-macros#225), so future stale entries won't hide.

The rpai plugin renamed llm to llm-provider, leaving two override
entries pointing at command paths that no longer exist (they fail
override validation on every regeneration and silently do nothing).
Move the provider-type note to rpk ai llm-provider, adding the
openai-compatible type the plugin now supports, and drop the llm check
description override: the renamed command's own help text already
covers it.
@JakeSCahill
JakeSCahill requested a review from a team as a code owner July 31, 2026 08:22
@netlify

netlify Bot commented Jul 31, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

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

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 8862ef4b-a976-4e28-b2c2-5da76b0c8053

📥 Commits

Reviewing files that changed from the base of the PR and between 32c36c6 and 335fd8c.

📒 Files selected for processing (1)
  • docs-data/rpk-overrides.json

📝 Walkthrough

Walkthrough

The documentation overrides rename rpk ai llm to rpk ai llm-provider. The supported provider list now includes openai-compatible. The rpk ai llm check command entry is removed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: feediver1

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the changes and scope but omits the required Jira, review deadline, page preview, and checks sections. Add the required template sections, including the Jira ticket, review deadline, page previews, and completed checks checklist.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation fix for stale overrides after the rpk ai llm command rename.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch cleanup/stale-rpk-ai-llm-overrides

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.

@JakeSCahill

Copy link
Copy Markdown
Contributor Author

Closing in favor of #1865: verified that the provider-type enumeration now reaches the docs through extraction from the source help itself (rpk ai llm-provider and create both carry it, including openai-compatible), so the migration this PR performed would duplicate upstream content. Michele's drift argument is correct.

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.

1 participant