Skip to content

docs: improve HTAP and Index terminology for better localization#22927

Open
yahonda wants to merge 4 commits into
pingcap:release-8.5from
yahonda:fix-english-storage-links
Open

docs: improve HTAP and Index terminology for better localization#22927
yahonda wants to merge 4 commits into
pingcap:release-8.5from
yahonda:fix-english-storage-links

Conversation

@yahonda
Copy link
Copy Markdown
Member

@yahonda yahonda commented May 26, 2026

This PR improves technical terminology in the English source to ensure more natural and accurate machine translations in other languages (specifically Japanese).

Changes:

  1. Changed 'storage links' to 'data pipelines' in the HTAP context.
  2. Changed 'storage model' to 'storage format' in the Secondary Indexes context.
  3. Changed 'region re-election' to 'region leader re-election' in the log backup architecture context to accurately reflect the Raft protocol where leaders, not regions, are elected.

These updates use more standard technical English, which helps translation engines produce clearer localized versions without the need for manual post-editing of awkward direct translations.

@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 26, 2026

[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 lilin90 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 missing-translation-status This PR does not have translation status info. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 26, 2026
Copy link
Copy Markdown
Contributor

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

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 updates the TiDB best practices documentation by changing "reduce storage links" to "reduce data pipelines" for clarity. The reviewer suggested a further improvement to use a more direct, active tone ("You want" instead of "You hope to have") and to simplify the phrasing to "simplified data pipelines", which aligns with the repository's style guide to avoid unnecessary words.

Comment thread best-practices/tidb-best-practices.md
@yahonda yahonda force-pushed the fix-english-storage-links branch from d1f1c26 to 0e6eab7 Compare May 26, 2026 04:26
@yahonda yahonda changed the title docs: improve HTAP terminology by changing 'storage links' to 'data pipelines' docs: improve HTAP and Index terminology for better localization May 26, 2026
@hfxsd hfxsd added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels May 26, 2026
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label May 26, 2026
@ti-chi-bot
Copy link
Copy Markdown

ti-chi-bot Bot commented May 26, 2026

[LGTM Timeline notifier]

Timeline:

  • 2026-05-26 07:24:59.796040876 +0000 UTC m=+336969.766205938: ☑️ agreed by qiancai.

Comment thread br/br-log-architecture.md Outdated
@qiancai qiancai self-assigned this May 26, 2026
@qiancai qiancai added needs-cherry-pick-master Should cherry pick this PR to master branch. translation/doing This PR's assignee is translating this PR. and removed translation/no-need No need to translate this PR. labels May 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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. translation/doing This PR's assignee is translating this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants