Fix Dumpling capitalization: product name should be capitalized#23042
Fix Dumpling capitalization: product name should be capitalized#23042yahonda wants to merge 1 commit into
Conversation
|
[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
missing-translation-status
![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 capitalizes "dumpling" to "Dumpling" across several documentation files to ensure consistent terminology. The reviewer suggested additional improvements to align with the style guide, such as avoiding passive voice, correcting "TiDB-Lightning" to "TiDB Lightning", and simplifying phrasing to make instructions more direct.
Important
The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.
| You can avoid this issue in advance by configuring in the following ways: | ||
|
|
||
| 1. Increase the value of `expire_logs_days` in the upstream MySQL database to avoid wrongly purging needed binlog files before the full migration task completes. If the data volume is large, it is recommended to use dumpling and TiDB-Lightning at the same time to speed up the task. | ||
| 1. Increase the value of `expire_logs_days` in the upstream MySQL database to avoid wrongly purging needed binlog files before the full migration task completes. If the data volume is large, it is recommended to use Dumpling and TiDB-Lightning at the same time to speed up the task. |
There was a problem hiding this comment.
The phrase "it is recommended to use" uses the passive voice. According to the style guide, we should avoid passive voice overuse and write in the second person ("you"). Additionally, "TiDB-Lightning" should be written as "TiDB Lightning" (without a hyphen) to maintain consistent terminology across the documentation.
| 1. Increase the value of `expire_logs_days` in the upstream MySQL database to avoid wrongly purging needed binlog files before the full migration task completes. If the data volume is large, it is recommended to use Dumpling and TiDB-Lightning at the same time to speed up the task. | |
| 1. Increase the value of `expire_logs_days` in the upstream MySQL database to avoid wrongly purging needed binlog files before the full migration task completes. If the data volume is large, we recommend that you use Dumpling and TiDB Lightning at the same time to speed up the task. |
References
- Avoid passive voice overuse and use consistent terminology (e.g., 'TiDB Lightning' instead of 'TiDB-Lightning'). (link)
| ## Step 1: Prepare full backup data | ||
|
|
||
| First, you can use [dumpling](/dumpling-overview.md) to export data from MySQL. | ||
| First, you can use [Dumpling](/dumpling-overview.md) to export data from MySQL. |
There was a problem hiding this comment.
The phrase "you can use" can be simplified to the direct imperative "use" to avoid unnecessary words and make the instruction more direct.
| First, you can use [Dumpling](/dumpling-overview.md) to export data from MySQL. | |
| First, use [Dumpling](/dumpling-overview.md) to export data from MySQL. |
References
- Avoid unnecessary words and repetition. (link)
yahonda
force-pushed
the
topic/fix-dumpling-capitalization-release-8.5
branch
from
3cdfb27 to
a9dafee
Compare
1 participant
What is changed, added or deleted? (Required)
Changed lowercase 'dumpling' to 'Dumpling' when it refers to the product name (TiDB data export tool) rather than the command line. This prevents mistranslation of the product name as a common noun (e.g., '餃子' or '団子' in Japanese) during localization.
Command line references (e.g.,
tiup dumpling) remain unchanged.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?