docs: drop the hand-written rpk connect run flags table - #1859
docs: drop the hand-written rpk connect run flags table#1859JakeSCahill wants to merge 1 commit into
Conversation
Written when plugin help carried no flag data, so the generator could not produce a table. Flag extraction now documents 13 flags for this command (the hand table listed 7 and had gone stale), and with both present the page rendered two conflicting == Flags sections. The per-flag description overrides stay: they merge onto the extracted table, so the curated log.level, set, and resources wording survives. Verified by regenerating with the doc-tools 5.3.0 branch: one Flags section, 13 rows, curated descriptions applied.
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Warning Review limit reached
Next review available in: 49 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
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 |
|
Superseded by #1865, which does everything this PR did plus per-flag description overrides for four more flags (chilled, watcher, env-file, templates). Closing in its favor. |
1 participant
Summary
Resolves the duplicate-Flags conflict found in review on docs-extensions-and-macros#225:
rpk connect runhad a hand-written Flags table (authored inrpk-overrides.jsonback when plugin help exposed no flag data) that now collides with the auto-extracted table. The generator's conflict rule keeps the curated section and skips extraction with a warning — this PR takes the warning's advice and adopts the extracted table, which is both fresher and fuller:--secrets,--redpanda-license, the telemetry flags,--rpc-pluginsThe per-flag description overrides stay — they merge onto the extracted rows, so the curated
log.level/set/resourceswording survives (verified: regenerated with the 5.3.0 branch, one== Flagssection, 13 rows, curated descriptions applied).Note: the page won't reflect this until the first regeneration with doc-tools ≥ 5.3.0 lands (flag extraction doesn't exist before it), so merge order vs #225's release train doesn't matter — this just needs to be in before the next regen.