Repository navigation
tiup: fix typos, flag names, Markdown, and wrong links in TiUP reference docs - #24486
Conversation
…nce docs - Fix single-dash flags that should be double-dash: --all, --enable-cpu, --enable-mem, --enable-disk, --cluster, --dir, and --transfer-timeout. - Fix list markers and code fences in blockquotes that did not render. - Fix wrong descriptions: tiup install installs components, log_dir is the log directory, worker_servers deploys worker nodes, and display displays nodes. - Fix wrong links and link formatting: cluster list, the cluster topology file, tiup dm display, and the scale-in link. - Fix typos: "at lease", ". /ansible.cfg", a missing space, a stray period, tiup dm list in a cluster page summary, and <component>[:version]. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Skipping CI for Draft Pull Request. |
ti-chi-bot
Bot
added
the
do-not-merge/work-in-progress
|
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 |
|---|---|
General TiUP command references tiup/tiup-command-mirror-*.md, tiup/tiup-component-management.md |
Corrected mirror command syntax and the hidden-component listing command. Updated component-list formatting and the tiup install description. |
Cluster command references tiup/tiup-component-cluster-*.md, tiup/tiup-cluster-topology-reference.md |
Corrected option syntax, command references, and descriptions. Updated links to cluster documentation. |
DM command and topology references tiup/tiup-component-dm-*.md, tiup/tiup-dm-topology-reference.md |
Corrected DM command links and topology-file wording. Updated the log_dir and worker_servers descriptions. |
Priority:
Estimated code review effort: 2 (Simple) | ~10 minutes
Change: Other
Suggested reviewers: qiancai
Merge Risk: 
32509
-
The documentation corrections present no identified merge-blocking risk.
Architecture risk: 
d5895
-
The change affects 1 system.
Changed systems:
tiupArchitecture concerns
No architecture-level concerns identified.Review details
-
Systems and components
- observed — tiup (service) was modified; 17 changed files map to changed impact.
Before / after behavior
- observed — Modified behavior in tiup/tiup-command-mirror-modify.md: Corrected the documented command syntax from
<component>[version]to<component>[:version]. - observed — Modified behavior in tiup/tiup-command-mirror-publish.md: Updated the documented command for listing hidden components from
tiup list -alltotiup list --all. - observed — Modified behavior in tiup/tiup-component-cluster-audit-cleanup.md: Corrected the command description’s spacing from
clustercommand toclustercommand. - observed — Modified behavior in tiup/tiup-component-cluster-check.md: Updated the CPU, memory, and related option documentation to use the double-hyphen forms
--enable-cpuand--enable-meminstead of single-hyphen forms.
-
Pre-merge checks: 
-
Check name Status Explanation Title check The title clearly summarizes the main changes: typo, flag name, Markdown, and link corrections in TiUP reference documentation. Description check The description includes the required change summary, affected versions, related-link section, AI involvement, and change-category checklist. The first-time contributor checklist is omitted, which is … Docstring Coverage No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Documentation-only edits and deletions within survi… 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 includes the required change summary, affected versions, related-link section, AI involvement, and change-category checklist. The first-time contributor checklist is omitted, which is allowed when 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. 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.
Comment @coderabbitai help to get the list of available commands.
ti-chi-bot
Bot
added
missing-translation-status
ti-chi-bot
Bot
removed
the
do-not-merge/work-in-progress
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🔇 Additional comments: 12
tiup/tiup-command-mirror-publish.md: 1
69-69: LGTM!tiup/tiup-component-management.md: 1
33-34: LGTM!tiup/tiup-component-cluster-audit-cleanup.md: 1
8-8: LGTM!tiup/tiup-component-cluster-check.md: 1
111-111: LGTM!Also applies to: 119-119, 131-131, 165-167, 235-235
tiup/tiup-component-cluster-clean.md: 1
29-29: LGTM!tiup/tiup-component-cluster-display.md: 1
30-30: LGTM!Also applies to: 34-34
tiup/tiup-component-cluster-import.md: 1
41-41: LGTM!Also applies to: 53-53
tiup/tiup-component-cluster-meta-backup.md: 1
3-3: LGTM!tiup/tiup-component-cluster-reload.md: 1
28-28: LGTM!tiup/tiup-component-cluster-scale-out.md: 1
18-20: LGTM!tiup/tiup-component-cluster-upgrade.md: 1
33-33: LGTM!tiup/tiup-component-management.md-54-54: 1
54-54: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
⚠️ Unverified finding
Verification ran but could not confirm this finding. It is shown for review, not as a verified issue.Use direct wording for the install command.
The changed sentence contains
This usage of this command is as follows, which is ungrammatical. Replace the changed line with:You can use the `tiup install` command to install components as follows:
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: pingcap/docs/.coderabbit.yaml
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
32df9fd6-2e41-4612-986c-8551886dad95
📒 Files selected for processing: 17
tiup/tiup-command-mirror-modify.mdtiup/tiup-command-mirror-publish.mdtiup/tiup-component-cluster-audit-cleanup.mdtiup/tiup-component-cluster-check.mdtiup/tiup-component-cluster-clean.mdtiup/tiup-component-cluster-display.mdtiup/tiup-component-cluster-import.mdtiup/tiup-component-cluster-meta-backup.mdtiup/tiup-component-cluster-reload.mdtiup/tiup-component-cluster-scale-out.mdtiup/tiup-component-cluster-upgrade.mdtiup/tiup-component-dm-edit-config.mdtiup/tiup-component-dm-patch.mdtiup/tiup-component-dm-prune.mdtiup/tiup-component-dm-restart.mdtiup/tiup-component-management.mdtiup/tiup-dm-topology-reference.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.
Use `<component>[:version]`, as the rest of the page does (`tiup [flags] <component>[:version]`, `tiup uninstall [component][:version]`). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
ti-chi-bot
Bot
removed
the
missing-translation-status
[LGTM Timeline notifier]Timeline:
|
qiancai
added
area/tiup
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: qiancai The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
qiancai
added
the
do-not-merge/hold
qiancai
removed
the
do-not-merge/hold
|
In response to a cherrypick label: new pull request created to branch |
What is changed, added, or deleted? (Required)
Fix typos, flag names, Markdown, and wrong links in the TiUP reference docs. These errors were found while reviewing the English docs for issues that affect the Japanese translation. Each fix is shown below; the same wrong text was also searched for in the rest of the docs.
--alland--verboselist items have no space after-, so the list does not rendertiup installcommand to query the component list" (Install components section)log_dir: "the data directory"worker_servers: "the master node of the DM component"tiup list -alltiup list --alltiup clustercommand"tiup clustercommand"-enable-cpu,-enable-mem,-enable-disk,-cluster--enable-cpu,--enable-mem,--enable-disk,--cluster(as in the headings)>. /ansible.cfg,-dir./ansible.cfg,--dirtiup dm listto check the cluster name"tiup cluster list-transfer-timeout--transfer-timeoutcluster listlinks to tiup-component-dm-list.md; the topology file links to tiup-dm-topology-reference.mdcluster listlinks to tiup-component-cluster-list.mdtiup dmpages)[tiup dm display](…)" (the link is inside a code span and does not render)tiup dm display"<component>[version]<component>[:version](as in the syntax)ng_port: Continuous Profiling (the Manual Profiling page)Which 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?
🤖 Generated with Claude Code
Summary by CodeRabbit