Revert "Revert "[v8.5.6] docs: update sync-diff-inspector docs for mo…#22674
Revert "Revert "[v8.5.6] docs: update sync-diff-inspector docs for mo…#22674hfxsd wants to merge 1 commit intofeature/preview-v8.5.6from
Conversation
…ve to ti…" This reverts commit 682e353.
hfxsd
added
the
translation/from-docs-cn
|
[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
contribution
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for the TiDB Toolkit and sync-diff-inspector to reflect changes for TiDB v8.5.6 and later, specifically noting that tools are now available via TiUP and that sync-diff-inspector is included in the tiflow package. The review feedback provides several actionable suggestions to improve the conciseness and readability of the new content by simplifying version descriptions and removing redundant phrasing, ensuring the documentation adheres to the style guide.
| This document describes how to download the TiDB Toolkit. | ||
|
|
||
| TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpling, data import tool TiDB Lightning, and backup and restore tool BR. | ||
| TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpling, data import tool TiDB Lightning, backup and restore tool BR, and data consistency checker sync-diff-inspector. |
There was a problem hiding this comment.
According to the style guide, we should avoid unnecessary words and repetition. Since this is the TiDB Toolkit, "TiDB tools" can be simplified to "tools". Also, consider a more concise format for the tool list.
| TiDB Toolkit contains frequently used TiDB tools, such as data export tool Dumpling, data import tool TiDB Lightning, backup and restore tool BR, and data consistency checker sync-diff-inspector. | |
| TiDB Toolkit contains frequently used tools, such as Dumpling (data export), TiDB Lightning (data import), BR (backup and restore), and sync-diff-inspector (data consistency check). |
References
- Avoid unnecessary words and repetition. (link)
| > **Tip:** | ||
| > | ||
| > - If your deployment environment has internet access, you can deploy a TiDB tool using a single [TiUP command](/tiup/tiup-component-management.md), so there is no need to download the TiDB Toolkit separately. | ||
| > - For TiDB v8.5.6 and later versions, most tools, including sync-diff-inspector, are directly available through TiUP. If your deployment environment has internet access, you can deploy a TiDB tool using a single [TiUP command](/tiup/tiup-component-management.md), so there is no need to download the TiDB Toolkit separately. |
There was a problem hiding this comment.
Simplify "v8.5.6 and later versions" to "v8.5.6 and later" for conciseness. Also, "without downloading" is more direct than "so there is no need to download".
| > - For TiDB v8.5.6 and later versions, most tools, including sync-diff-inspector, are directly available through TiUP. If your deployment environment has internet access, you can deploy a TiDB tool using a single [TiUP command](/tiup/tiup-component-management.md), so there is no need to download the TiDB Toolkit separately. | |
| > - For TiDB v8.5.6 and later, most tools, including sync-diff-inspector, are directly available through TiUP. If your deployment environment has internet access, you can deploy a tool using a single [TiUP command](/tiup/tiup-component-management.md) without downloading the TiDB Toolkit separately. |
References
- Avoid unnecessary words and repetition. (link)
| | [TiCDC](/ticdc/ticdc-overview.md) | `cdc-{version}-linux-{arch}.tar.gz` | | ||
| | [Backup & Restore (BR)](/br/backup-and-restore-overview.md) | `br-{version}-linux-{arch}.tar.gz` | | ||
| | [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | `sync_diff_inspector` | | ||
| | [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v8.5.6 and later versions: `tiflow-{version}-linux-{arch}.tar.gz` <br/>For TiDB versions before v8.5.6: `sync_diff_inspector` | |
There was a problem hiding this comment.
Concise phrasing is preferred. "v8.5.6 and later" is sufficient.
| | [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v8.5.6 and later versions: `tiflow-{version}-linux-{arch}.tar.gz` <br/>For TiDB versions before v8.5.6: `sync_diff_inspector` | | |
| | [sync-diff-inspector](/sync-diff-inspector/sync-diff-inspector-overview.md) | For TiDB v8.5.6 and later: `tiflow-{version}-linux-{arch}.tar.gz` <br/>For versions before v8.5.6: `sync_diff_inspector` | |
References
- Avoid unnecessary words and repetition. (link)
|
|
||
| The installation method varies depending on your TiDB version: | ||
|
|
||
| For TiDB v8.5.6 and later versions: |
There was a problem hiding this comment.
Simplify the version description for better readability.
| For TiDB v8.5.6 and later versions: | |
| For TiDB v8.5.6 and later: |
References
- Avoid unnecessary words and repetition. (link)
| tiup install sync-diff-inspector | ||
| ``` | ||
|
|
||
| + Binary package. The sync-diff-inspector binary package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md). |
There was a problem hiding this comment.
The phrase "The sync-diff-inspector binary package" is repetitive since the list item already starts with "Binary package".
| + Binary package. The sync-diff-inspector binary package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md). | |
| + Binary package: included in the TiDB Toolkit. To download the toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md). |
References
- Avoid unnecessary words and repetition. (link)
|
|
||
| + Binary package. The sync-diff-inspector binary package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md). | ||
|
|
||
| + Docker image. Execute the following command to download: |
There was a problem hiding this comment.
Use a colon to introduce the instruction for better flow.
| + Docker image. Execute the following command to download: | |
| + Docker image: execute the following command to download: |
References
- Clarity, simplicity, completeness, and readability (link)
| docker pull pingcap/sync-diff-inspector:latest | ||
| ``` | ||
|
|
||
| For TiDB versions before v8.5.6: |
There was a problem hiding this comment.
Simplify the version description.
| For TiDB versions before v8.5.6: | |
| For versions before v8.5.6: |
References
- Avoid unnecessary words and repetition. (link)
|
|
||
| For TiDB versions before v8.5.6: | ||
|
|
||
| + Binary package from the legacy [`tidb-tools`](https://github.com/pingcap/tidb-tools) repository. The sync-diff-inspector binary package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md). |
There was a problem hiding this comment.
Reduce repetition and clarify the source of the legacy package.
| + Binary package from the legacy [`tidb-tools`](https://github.com/pingcap/tidb-tools) repository. The sync-diff-inspector binary package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md). | |
| + Binary package: included in the TiDB Toolkit (from the legacy [`tidb-tools`](https://github.com/pingcap/tidb-tools) repository). To download the toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md). |
References
- Avoid unnecessary words and repetition. (link)
|
|
||
| + Binary package from the legacy [`tidb-tools`](https://github.com/pingcap/tidb-tools) repository. The sync-diff-inspector binary package is included in the TiDB Toolkit. To download the TiDB Toolkit, see [Download TiDB Tools](/download-ecosystem-tools.md). | ||
|
|
||
| + Docker image (legacy version). Execute the following command to download: |
There was a problem hiding this comment.
Use a colon to introduce the instruction.
| + Docker image (legacy version). Execute the following command to download: | |
| + Docker image (legacy version): execute the following command to download: |
References
- Clarity, simplicity, completeness, and readability (link)
1 participant
…ve to ti…"
This reverts commit 682e353.
First-time contributors' checklist
What is changed, added or deleted? (Required)
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)?
Do your changes match any of the following descriptions?