docs: migrate stale rpk ai llm overrides to the renamed command - #1858
docs: migrate stale rpk ai llm overrides to the renamed command#1858JakeSCahill wants to merge 1 commit into
Conversation
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.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe documentation overrides rename Estimated code review effort: 1 (Trivial) | ~2 minutes Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Closing in favor of #1865: verified that the provider-type enumeration now reaches the docs through extraction from the source help itself ( |
Summary
Flagged in review on docs-extensions-and-macros#225: every rpk docs regeneration prints override validation errors for
rpk ai llmandrpk ai llm check— the rpai plugin renamedllm→llm-provider, so those entries silently do nothing.rpk ai llm-provider(withopenai-compatibleadded, matching the plugin's current config groups).llm checkdescription 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.