Skip to content

Fix tool name capitalization for product names to prevent mistranslation#23043

Open
yahonda wants to merge 4 commits into
pingcap:release-8.5from
yahonda:topic/fix-tool-names-capitalization-release-8.5
Open

Fix tool name capitalization for product names to prevent mistranslation#23043
yahonda wants to merge 4 commits into
pingcap:release-8.5from
yahonda:topic/fix-tool-names-capitalization-release-8.5

Conversation

@yahonda

@yahonda yahonda commented Jun 11, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Changed lowercase product names to proper capitalization in prose text to prevent mistranslation during localization (e.g., Japanese translation):

  • 'lightning' -> 'Lightning' (could be mistranslated as 雷/稲妻)
  • 'pump' -> 'Pump' (could be mistranslated as ポンプ)
  • 'tiflash' -> 'TiFlash' (when used as product name in prose)

Note: 'syncer' is not changed as it is not maintained and should remain lowercase.

Command line references, file names, URLs, paths, and configuration values 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.

  • master (the latest development version)
  • v8.5 (TiDB 8.5 versions)
  • v8.4 (TiDB 8.4 versions)
  • v8.3 (TiDB 8.3 versions)
  • v8.2 (TiDB 8.2 versions)
  • v8.1 (TiDB 8.1 versions)
  • v7.5 (TiDB 7.5 versions)
  • v7.1 (TiDB 7.1 versions)
  • v6.5 (TiDB 6.5 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)

What is the related PR or file link(s)?

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Jun 11, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 11, 2026

Copy link
Copy Markdown

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign icemap for approval. For more information see the Code Review Process.
Please ensure that each of them provides their approval before proceeding.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@ti-chi-bot ti-chi-bot Bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Jun 11, 2026

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request standardizes the capitalization of various component names (such as Syncer, Pump, Lightning, and TiFlash) across multiple documentation files. The review feedback provides actionable suggestions to further align the text with the style guide, including converting passive voice to active voice, writing in the second person ("you"), correcting grammatical issues, and ensuring consistent terminology (e.g., using "parameter" instead of "item" and capitalizing join types).

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.

Comment thread dm/dm-continuous-data-validation.md Outdated
Comment thread dm/dm-safe-mode.md Outdated
Comment thread dm/dm-safe-mode.md Outdated
Comment thread releases/release-3.0.3.md
Comment thread releases/release-6.1.1.md Outdated
Comment thread system-variables.md
Comment thread tiflash/create-tiflash-replicas.md Outdated
@ti-chi-bot ti-chi-bot Bot added size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Jun 11, 2026
@yahonda yahonda force-pushed the topic/fix-tool-names-capitalization-release-8.5 branch from 242fd24 to 49e188b Compare June 11, 2026 07:48
Comment thread releases/release-6.1.1.md Outdated
Co-authored-by: Grace Cai <qqzczy@126.com>
Comment thread tiflash/create-tiflash-replicas.md Outdated
Co-authored-by: Grace Cai <qqzczy@126.com>
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Jun 12, 2026
@ti-chi-bot

ti-chi-bot Bot commented Jun 12, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-06-12 06:00:50.549328281 +0000 UTC m=+1112551.619645661: ☑️ agreed by qiancai.

@qiancai qiancai self-assigned this Jun 12, 2026
@qiancai qiancai added the needs-cherry-pick-master Should cherry pick this PR to master branch. label Jun 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

missing-translation-status This PR does not have translation status info. needs-1-more-lgtm Indicates a PR needs 1 more LGTM. needs-cherry-pick-master Should cherry pick this PR to master branch. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants