fix(DOC-1675): document --overprovisioned flag and improve rpk redpanda start prose

[mfernest]

Summary

• Adds the missing --overprovisioned flag to the rpk redpanda start flags table with a description explaining that it disables thread affinity (CPU pinning) to allow fairer CPU distribution and must not be used in production environments
• Fixes several pre-existing prose issues: lowercase redpanda in prose, setup used as a verb, missing comma after introductory clause, future tense (will disable/enable), comparative terser, and weak constructions (It's possible to, When present will)

Test plan

• Verify --overprovisioned flag appears in the flags table with correct description
• Verify prose fixes render correctly in the preview

🤖 Generated with Claude Code

[netlify]

✅ Deploy Preview for redpanda-docs-preview ready!

Name	Link
🔨 Latest commit	7699ad9
🔍 Latest deploy log	https://app.netlify.com/projects/redpanda-docs-preview/deploys/69bafa01f9222000089d85b5
😎 Deploy Preview	https://deploy-preview-1618--redpanda-docs-preview.netlify.app
📱 Preview on mobile	Toggle 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]

📝 Walkthrough

Walkthrough

Documentation updates to the rpk redpanda start command reference page. Changes include grammar corrections, capitalization improvements, and phrasing refinements across multiple sections. A new --overprovisioned flag is added with its description, which disables thread affinity for fairer CPU distribution. Existing flag descriptions are reworded for clarity, including updates to --check, --tune, --config, and --set flags. The document maintains functional accuracy while improving readability and consistency.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested reviewers

• r-vasquez
• micheleRP
• kbatuigas

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is incomplete according to the repository template; it lacks required sections including JIRA ticket link, page preview link, review deadline, and checkbox selections.	Add missing template sections: include the JIRA ticket URL (DOC-1675), provide page preview link from Netlify bot, specify review deadline, and select appropriate checkboxes (Small fix is most applicable).

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately summarizes the main changes: adding documentation for the --overprovisioned flag and improving prose quality in the rpk redpanda start documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch fix/doc-1675-overprovisioned-flag

📝 Coding Plan

• Generate coding plan for human review comments

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

🧹 Nitpick comments (1)

modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc (1)

101-102: Consider linking --overprovisioned to the mode reference for deeper context.

Optional docs polish: append an xref to the rpk redpanda mode page so readers can immediately see the full implications of this flag (for example, dev-mode side effects beyond CPU pinning).

✍️ Suggested doc tweak

-|--overprovisioned |- |Disables thread affinity (CPU pinning) to allow fairer CPU distribution among all processes. Do not use in production environments. Set automatically by `--mode dev-container`.
+|--overprovisioned |- |Disables thread affinity (CPU pinning) to allow fairer CPU distribution among all processes. Do not use in production environments. Set automatically by `--mode dev-container`. For details, see xref:reference:rpk/rpk-redpanda/rpk-redpanda-mode.adoc[].

Based on learnings, AsciiDoc links with empty brackets are preferred in this repository.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc` around
lines 101 - 102, Add an AsciiDoc cross-reference from the --overprovisioned
entry to the rpk redpanda mode reference so readers can jump to full mode
details: locate the table cell containing the --overprovisioned description and
append an xref to the "rpk redpanda mode" page using the repository-preferred
empty-bracket syntax; ensure the link text is not added (use the empty brackets
style) and that the xref points to the correct page ID/title for the rpk
redpanda mode documentation.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc`:
- Around line 101-102: Add an AsciiDoc cross-reference from the
--overprovisioned entry to the rpk redpanda mode reference so readers can jump
to full mode details: locate the table cell containing the --overprovisioned
description and append an xref to the "rpk redpanda mode" page using the
repository-preferred empty-bracket syntax; ensure the link text is not added
(use the empty brackets style) and that the xref points to the correct page
ID/title for the rpk redpanda mode documentation.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ff6ed3f0-19d6-4a2d-be58-b253220450ca

📥 Commits

Reviewing files that changed from the base of the PR and between 49e7aa6 and 7699ad9.

📒 Files selected for processing (1)

• modules/reference/pages/rpk/rpk-redpanda/rpk-redpanda-start.adoc