Skip to content

docs: stop excluding rpk ai connection from the rpk reference - #1869

Merged
JakeSCahill merged 1 commit into
mainfrom
michele/unexclude-rpk-ai-connection
Aug 1, 2026
Merged

docs: stop excluding rpk ai connection from the rpk reference#1869
JakeSCahill merged 1 commit into
mainfrom
michele/unexclude-rpk-ai-connection

Conversation

@micheleRP

Copy link
Copy Markdown
Contributor

What

Remove the three exclude overrides for rpk ai connection, rpk ai connection list, and rpk ai connection revoke from docs-data/rpk-overrides.json.

Why

The rpk ai connection group graduated from a coming-soon stub to working commands in plugin v0.2.32, and the ADP release notes announce it as a feature. The excludes date from the stub era. With them in place, the plugin-docs regen (#1868) refreshes the snapshot correctly (the connection commands are present with real help text) but renders no pages for them: shouldExcludeCommand walks these entries and drops the subtree.

After this merges, re-dispatching update-rpk-plugin-docs.yml for ai updates #1868 in place with the connection partials.

Related: #1865 cleans up other stale rpk ai override paths (the rpk ai llm check warnings in the regen log) but doesn't touch these entries; the two changes are independent.

🤖 Generated with Claude Code

The rpk ai connection command group graduated from a coming-soon stub
to working commands (list, revoke) in plugin v0.2.32 and is announced
in the ADP release notes. The exclude overrides date from the stub era
and now suppress the pages for a shipped, release-noted feature: the
plugin-docs regen (docs PR #1868) refreshed the snapshot with the
connection commands but rendered nothing for them because of these
entries.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@micheleRP
micheleRP requested a review from a team as a code owner August 1, 2026 04:16
@netlify

netlify Bot commented Aug 1, 2026

Copy link
Copy Markdown

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit 4736a38
🔍 Latest deploy log https://app.netlify.com/projects/redpanda-docs-preview/deploys/6a6d7303bd9490000891c37e
😎 Deploy Preview https://deploy-preview-1869--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 Aug 1, 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

Run ID: cc188904-d926-46d5-8c1b-b2f0ccc5ac2b

📥 Commits

Reviewing files that changed from the base of the PR and between 83724d4 and 4736a38.

📒 Files selected for processing (1)
  • docs-data/rpk-overrides.json
💤 Files with no reviewable changes (1)
  • docs-data/rpk-overrides.json

📝 Walkthrough

Walkthrough

The documentation override file no longer excludes rpk ai connection, rpk ai connection list, or rpk ai connection revoke. Documentation generation can now include these commands.

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

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains what and why, but it omits the required Jira resolution, review deadline, page previews, and checks sections. Add the required template sections, provide the Jira ticket and review deadline, include page previews, and select the applicable check.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the removal of exclusions for the rpk ai connection commands.
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 michele/unexclude-rpk-ai-connection

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

@JakeSCahill
JakeSCahill merged commit 6d9b7c2 into main Aug 1, 2026
10 checks passed
@JakeSCahill
JakeSCahill deleted the michele/unexclude-rpk-ai-connection branch August 1, 2026 05:21

@JakeSCahill JakeSCahill left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Verified: clean removal of the three stub-era excludes, and the #1868 snapshot already carries the connection commands with real help text, so the re-dispatch will render them (pages, nav, and the adp-docs reconcile downstream). One non-blocking nit: the excluded_commands doc-string at the top of the file still mentions the connection subtree — worth sweeping in #1865 since it edits neighboring entries.

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.

2 participants