Repository navigation
tiup: fix typos, flag names, Markdown, and wrong links in TiUP reference docs (#24486) - #24563
ti-chi-bot wants to merge 5 commits into
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>
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
added
area/tiup
|
[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 |
Walkthrough
Merge Risk:
 |
| Check name | Status | Explanation |
|---|---|---|
| Title check |  |
The title clearly summarizes the documentation changes, including typo fixes, flag corrections, Markdown updates, and link corrections in TiUP reference docs. |
| Description check | |
The description covers the required change summary, affected versions, AI involvement, and applicable checklist items. The optional first-time contributor section is omitted, and no critical informati… |
| 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 covers the required change summary, affected versions, AI involvement, and applicable checklist items. The optional first-time contributor section is omitted, and no critical information is missing.
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. (22 skipped: 22 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.
![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
-
-
- Source mode: Auto
- Repository: pingcap/docs
- Branch: release-8.5
- File: .coderabbit.yaml
- Commit: 636d630
- Layers: Repository YAML
- Review profile: ASSERTIVE
- Plan: Advanced
- Run ID:
1c6b0765-c8a7-4062-a26a-a6b5e2cd8b4b
-
tiup/tiup-cluster-topology-reference.mdtiup/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-dm-scale-in.mdtiup/tiup-component-dm-scale-out.mdtiup/tiup-component-dm-start.mdtiup/tiup-component-dm-stop.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; 0 remain after this review.
-
| ## Install components | ||
|
|
||
| You can use the `tiup install` command to query the component list. This usage of this command is as follows: | ||
| You can use the `tiup install` command to install components. This usage of this command is as follows: |
There was a problem hiding this comment.
Use standard syntax wording for the install section.
The phrase “This usage of this command is as follows” is ungrammatical. Replace it with “The syntax of this command is as follows.”
Committable wording
-
--- "a/tiup/tiup-component-management.md" +++ "b/tiup/tiup-component-management.md" @@ -50,7 +50,7 @@ ## Install components -You can use the `tiup install` command to install components. This usage of this command is as follows: +You can use the `tiup install` command to install components. The syntax of this command is as follows: - `tiup install <component>`: installs the latest stable version of a specified component. - `tiup install <component>[:version]`: installs the specified version of a specified component.
Committable suggestion
-
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.Suggested changeYou can use the `tiup install` command to install components. This usage of this command is as follows: You can use the `tiup install` command to install components. The syntax of this command is as follows:
Source: Path instructions
This is an automated cherry-pick of #24486
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