Repository navigation
Fix deployment doc inconsistencies - #24451
doc-claw-bot wants to merge 6 commits into
Conversation
ti-chi-bot
Bot
added
contribution
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review.
 |
| Layer / File(s) | Summary |
|---|---|
Deployment guidance check-before-deployment.md, production-deployment-using-tiup.md |
Swap guidance distinguishes disabling swap for latency-sensitive hosts from setting vm.swappiness=0 when memory is insufficient. It adds steps to disable swap, prevent its reactivation, and check its status after reboot. The TiUP example uses .tidb-version, and the stated scenario count changes from six to five. |
Post-installation login post-installation-check.md |
Dashboard and database login instructions specify the root username and explain when to enter a password or omit -p. |
Estimated code review effort: 2 (Simple) | ~8 minutes
Change: Other
Suggested reviewers: hfxsd, qiancai
Merge Risk: 
66514
-
The documentation updates are ready to merge with no verified blocking risk.
Architecture risk: 
9146c
-
The change affects 3 systems.
Changed systems:
check-before-deployment.md,post-installation-check.md,production-deployment-using-tiup.mdArchitecture concerns
No architecture-level concerns identified.Review details
-
Systems and components
- observed — check-before-deployment.md (service) was modified; 1 changed file maps to changed impact.
- observed — post-installation-check.md (service) was modified; 1 changed file maps to changed impact.
- observed — production-deployment-using-tiup.md (service) was modified; 1 changed file maps to changed impact.
Before / after behavior
- observed — Modified behavior in check-before-deployment.md: The swap instructions now use
swapoff -ato disable active swap and remove or comment out the/etc/fstabswap entry to keep it disabled after reboot. The previous permanent-disable procedure that setvm.swappiness = 0and ranswapoff -a && swapon -awas removed; the separate low-memory swap-priority guidance remains unchanged. - observed — Modified behavior in check-before-deployment.md: The TiUP deployment example replaces the fixed
v6.1.0version with the.tidb-versiontemplate. - observed — Modified behavior in post-installation-check.md: Added conditional login instructions: when the cluster was started with
--init, use the-poption and enter the generated password. - observed — Modified behavior in production-deployment-using-tiup.md: The introduction now says the examples cover five common scenarios instead of six.
-
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly identifies the main change: fixing inconsistencies in the deployment documentation. Description check The description explains the four documentation changes, identifies the affected versions, provides a related link, and completes the AI involvement and change-type sections. The first-time contributo… Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Linked Issues check Check skipped because no linked issues were found for this pull request. Out of Scope Changes check Check skipped because no linked issues were found for this pull request. Full details: Description check
-
Explanation
The description explains the four documentation changes, identifies the affected versions, provides a related link, and completes the AI involvement and change-type sections. The first-time contributor checklist is omitted, which is acceptable if the author is not a first-time contributor.
Full details: Docstring Coverage
-
Explanation
No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
-
Finishing Touches
-
Generate unit tests (beta)
-
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
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.
doc-claw-bot
added
type/bugfix
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
aaf2cebe-2c1c-4fb6-98eb-029d69f4b9cb
📒 Files selected for processing: 3
check-before-deployment.mdpost-installation-check.mdproduction-deployment-using-tiup.md
Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
ti-chi-bot
Bot
added
size/M
qiancai
changed the title
What is changed, added, or deleted? (Required)
Fix four deployment-doc inconsistencies in the TiDB Self-Managed guides:
v6.1.0NUMA deployment example with the version placeholderv{{{ .tidb-version }}}tiup cluster start --initrequire-pwhen logging in asrootWhich TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
AI agent involvement
Do your changes match any of the following descriptions?
Summary by CodeRabbit