Skip to content

i18n(ja): fix severe false-friend mistranslations in tiproxy and faq - #23882

Open
yahonda wants to merge 7 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-tiproxy-faq-defects
Open

yahonda wants to merge 7 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-tiproxy-faq-defects

Conversation

@yahonda

@yahonda yahonda commented Sep 16, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Fixes defects found during a full-corpus JA-vs-EN review of tiproxy/ and faq/ (batch 6 of the ongoing review campaign). Highlights:

Severe false-friend mistranslations (changes meaning entirely):

  • faq/manage-cluster-faq.md: "PD" (Placement Driver) glossed as "パーキンソン病" (Parkinson's disease) in a section intro
  • faq/sql-faq.md: "common hotspots" mistranslated as "一般的な鍋料理" (a common hot pot dish)
  • tiproxy/tiproxy-overview.md: connector table version 5.1.19 mistranslated into a calendar date "2019年5月1日"; language name "Go" mistranslated as "行く" (the verb "to go"); connector name "MySQL Connector/Node.js" partially translated as "MySQLコネクタ/Node.js"
  • tiproxy/tiproxy-grafana.md: Grafana panel/row names mistranslated throughout the file (see below)
  • faq/manage-cluster-faq.md: "guarantee data safety" mistranslated as "guarantee data's Raft-ness"; a reversed information_schema/create_time containment relation
  • tiproxy/tiproxy-configuration.md: "drains clients" mistranslated as "client load increases" (the opposite claim)

Grafana panel/row names restored to literal English (tiproxy/tiproxy-grafana.md):
Verified against the real dashboard JSON (pingcap/tiproxy's pkg/metrics/grafana/tiproxy_summary.json) and TiProxy's Go source (pkg/proxy/backend/error.go). Restores 5 section headings, 22 panel-name bullet labels, and 11 Disconnection OPM reason labels (success, client network break, auth fail, etc. — literal strings returned by the Go source and shown verbatim as the panel's legend values) that had all been translated into Japanese.

Other real mistranslations / content defects:

  • faq/sql-faq.md: a "General DDL" table row severely scrambled (dropped row header, misattached qualifier); a spurious invented "version 5"; SELECT FOR UPDATE subject misplaced mid-verb; reversed schema/version word order (2 sites); a heading's quote-mark style inconsistent with its sibling heading; unnatural word order around "SELECT VERSION()'s return value"
  • faq/backup-and-restore-faq.md: a dropped version number (v7.1.0); orphaned closing quote marks in 3 headings; a tilde (~) misused in place of the particle; a dropped particle
  • tiproxy/tiproxy-load-balance.md: dropped "by querying its error count" mechanism
  • tiproxy/tiproxy-overview.md: a scope-generalization error (EN's "by scaling out" modifies only one of two options); a stray inserted "エラーコード" (error code) phrase; a confusingly-phrased sentence about prepared-statement invalidation that read as an unconditional consequence
  • Garbled "possible values" config lists in tiproxy/tiproxy-configuration.md (4 sites) and tiproxy/tiproxy-command-line-flags.md (1 site)
  • Literal field/section names mistranslated: auto-certs config field, ha TOML section
  • Duplicated/orphaned text fragments: faq/migration-tidb-faq.md, tiproxy/tiproxy-deployment-topology.md ("TiUPTiUP" + dropped "cluster"), faq/tidb-faq.md (stray leading "TiDB")
  • Same-file register inconsistencies: サーバ/サーバー in tiproxy/tiproxy-grafana.md and tiproxy/tiproxy-load-balance.md; duplicated "照合順序" in faq/sql-faq.md; a blunt word choice (役に立たない -> 効果のない) for a config-field description
  • Recurring dropped を参照してください truncated to bare 参照。 (9 sites across faq/sql-faq.md, faq/tidb-faq.md, faq/deploy-and-maintain-faq.md)
  • 5 sites with a dropped particle right after a backtick example value in tiproxy/tiproxy-grafana.md

All fixes were individually re-verified against the live file and the EN source (upstream/release-8.5) before being applied.

Which TiDB version(s) do your changes apply to? (Required)

  • i18n-ja-release-8.5 (TiDB Japanese documentation for TiDB 8.5 versions)

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

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

AI agent involvement

  • The changes in this PR were primarily made by an AI agent on behalf of the PR author.

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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Improved Japanese FAQ wording, headings, references, terminology, and formatting across backup, deployment, cluster management, migration, SQL, architecture, and upgrade topics.
    • Clarified upgrade guidance, including recommendations for TiUP and Kubernetes deployments.
    • Updated TiProxy documentation with clearer configuration options, logging values, deployment guidance, monitoring terminology, load-balancing descriptions, and troubleshooting instructions.
    • Corrected typos, misleading translations, version references, and formatting issues without changing product functionality.

Fixes defects found during the full-corpus JA review of tiproxy/ and
faq/ (batch 6), including several severe false-friend mistranslations:
"PD" (Placement Driver) glossed as Parkinson's disease, "common
hotspots" as a hot pot dish, "Go" the language as "to go", a version
number turned into a calendar date, and "drains clients" reversed into
"client load increases". Also fixes a reversed information_schema/
create_time containment relation, a severely scrambled DDL-type table
row, several garbled "possible values" config lists, dropped clauses,
duplicated/orphaned text fragments, and same-file register
inconsistencies (サーバ/サーバー).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ti-chi-bot

ti-chi-bot Bot commented Sep 16, 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 overvenus 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/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 16, 2026
@coderabbitai

coderabbitai Bot commented Sep 16, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Changes

Documentation corrections

Layer / File(s) Summary
Operational FAQ corrections
faq/backup-and-restore-faq.md, faq/deploy-and-maintain-faq.md, faq/manage-cluster-faq.md, faq/migration-tidb-faq.md, faq/upgrade-faq.md
Corrected Japanese wording, headings, terminology, version references, and FAQ descriptions.
SQL and TiDB FAQ corrections
faq/sql-faq.md, faq/tidb-faq.md
Corrected references, code spans, SQL operation lists, terminology, links, and FAQ headings.
TiProxy documentation corrections
tiproxy/*.md
Corrected option formats, headings, terminology, connector versions, load-balancing descriptions, and troubleshooting text.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~10 minutes

Change: Bug fix

Suggested reviewers: qiancai

Merge Risk: 🔵 Low · up to 957c6

Readers may misunderstand these FAQ and deployment instructions, but the issues are limited to documentation and do not affect runtime behavior.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly identifies the main change: correcting severe Japanese false-friend mistranslations in the TiProxy and FAQ documentation.
Description check ✅ Passed The description is complete and directly matches the documentation-only changes. It explains the defects fixed, identifies the affected Japanese TiDB 8.5 documentation branch, records AI involvement, …
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 4


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 0f612b2f-0206-44d5-9678-332b57d9abdf

📥 Commits

Reviewing files that changed from the base of the PR and between 09ec082 and ab0b868.

📒 Files selected for processing (14)
  • faq/backup-and-restore-faq.md
  • faq/deploy-and-maintain-faq.md
  • faq/manage-cluster-faq.md
  • faq/migration-tidb-faq.md
  • faq/sql-faq.md
  • faq/tidb-faq.md
  • faq/upgrade-faq.md
  • tiproxy/tiproxy-command-line-flags.md
  • tiproxy/tiproxy-configuration.md
  • tiproxy/tiproxy-deployment-topology.md
  • tiproxy/tiproxy-grafana.md
  • tiproxy/tiproxy-load-balance.md
  • tiproxy/tiproxy-overview.md
  • tiproxy/troubleshoot-tiproxy.md

Included review availability: Your plan provides up to 4 included reviews per hour; 2 remain after this review.

Comment thread faq/migration-tidb-faq.md
Comment thread faq/sql-faq.md Outdated
Comment thread faq/sql-faq.md Outdated
Comment thread tiproxy/tiproxy-deployment-topology.md
yahonda and others added 3 commits September 16, 2026 10:42
Per CodeRabbit review on pingcap#23882: fix the reversed "バージョンschema"
word order (should be "schemaバージョン", matching EN's "schema
version" and a sibling bullet already using the correct order in the
same Note block), and remove the incorrect "コミットした" (already
committed) qualifier before a transaction that is being rolled back,
which contradicted itself (a committed transaction cannot be rolled
back).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Change a heading's Japanese corner-bracket quoting of a literal error
message to a backtick code span, matching the sibling heading right
above it and the body text's own formatting for the same string.

Also fix an unnatural word order around "SELECT VERSION()'s return
value" that read ambiguously without a connecting particle.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Replace 役に立たない ("useless", a fairly blunt word choice for a
field name in JA technical writing) with 効果のない ("has no effect"),
which conveys the same meaning as EN's "Useless fields" without the
harsher tone.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Outside the diff (1)

🟡 Minor · Repair the Reorg DDL table row.

faq/sql-faq.md:254
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

Repair the Reorg DDL table row.

ADD INDEX and MODIFY COLUMN run together, and the row has an unmatched opening parenthesis. This makes the operation examples ambiguous.

Proposed wording

| 再編成DDL(`ADD INDEX``MODIFY COLUMN`(再編成タイプのデータ変更)など) | データ量、システム負荷、DDL パラメータ設定によって異なります。 |

As per path instructions, this deterministic replacement is provided as proposed wording because Line 254 is outside the shown changed ranges.

Source: Path instructions


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 274212c9-c544-4ae5-b42f-1abff58b297a

📥 Commits

Reviewing files that changed from the base of the PR and between cce32b9 and 957c631.

📒 Files selected for processing (1)
  • faq/sql-faq.md

Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review.

yahonda and others added 3 commits September 16, 2026 11:01
Grafana panel/row names are literal dashboard-JSON strings (verified
against pingcap/tiproxy's tiproxy_summary.json) and must stay in
English, matching EN's own text and the established
ja-grafana-panel-names-english campaign convention. Restores all 5
section headings and 22 panel-name bullet labels in this file that had
been translated into Japanese.

Also fixes 5 sites with a dropped は particle right after a backtick
example value, one fullwidth/halfwidth colon inconsistency, an
unnatural connector-name translation in tiproxy-overview.md's
connector table (MySQLコネクタ/Node.js -> MySQL Connector/Node.js,
matching sibling literal connector names in the same table), and a
confusingly-phrased sentence about prepared statement invalidation
that read as an unconditional consequence rather than a coincidental
state.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
The Disconnection OPM panel's reason labels (success, client network
break, auth fail, etc.) are literal strings returned by TiProxy's Go
source (pkg/proxy/backend/error.go) and shown verbatim as the
Disconnection OPM panel's legend values ({{type}}) in Grafana -- not
descriptive prose to translate. Restores all 11 labels to literal
English, keeping the Japanese explanation after each colon.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Match the parallel "proxy error: その他の TiProxy エラー" line right
below it -- both describe the same "not otherwise categorized" catch-
all bucket in the source (SrcClientSQLErr / SrcProxyErr), so they
should read the same way in Japanese.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant