Skip to content

i18n(ja): restore 4-word and 3-word TiDB Cloud UI labels to English - #23519

Open
yahonda wants to merge 31 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-ui-labels-english-3-4-word-2026-08-13
Open

i18n(ja): restore 4-word and 3-word TiDB Cloud UI labels to English#23519
yahonda wants to merge 31 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-ui-labels-english-3-4-word-2026-08-13

Conversation

@yahonda

@yahonda yahonda commented Aug 13, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

TiDB Cloud web console UI labels (button/tab/field/page names, wrapped in **...**) were translated into Japanese instead of being kept in English, inconsistent with how UI strings are usually handled elsewhere in the ja docs. See maintainer guidance: #23455 (comment)

This PR restores 4-word and 3-word TiDB Cloud UI labels across tidb-cloud/ (excluding releases/) back to English, using EN/JA bold-span positional pairing per file, limited to files where EN and JA bold-span counts matched exactly.

A conservative verification pass was then run over every touched file, checking each restored label against the actual TiDB Cloud console frontend source (a private repo the reviewer made available for this purpose) to confirm it is genuinely a literal UI string, not just a descriptive/emphasis phrase EN happens to bold. Spans that could not be confirmed as literal UI text were reverted back to their original Japanese wording. Third-party console labels (AWS/Azure/Alibaba Cloud/GCP/PagerDuty/Slack/Datadog/New Relic/Airbyte/n8n/Vercel/Zapier, etc.) were judged on general knowledge of those stable, well-known UI conventions, since they aren't in the TiDB Cloud frontend source.

Along the way this also fixed several pre-existing MT defects surfaced during the audit:

  • stray leftover decoration characters (「」[]) split across the wrong side of ** bold markers ("straddling bracket" defect)
  • dropped particles (を/が/の) adjacent to restored spans
  • a few cases where the mechanical pass mapped the wrong adjacent English phrase onto a position (e.g. a Connect/Disconnect toggle button mislabeled with its section's title instead of its own text; Log Filter Rules/Add Filter Rule swapped in the TiDB Cloud auditing docs)
  • literal Hugo template placeholders ({{{ .premium }}} etc.) that leaked into JA prose in place of the resolved product name, in a file where the JA translation otherwise never uses templates
  • one case where the JA bold span covered far more text than the actual label, causing content loss

Where the actual current console text has drifted from what the EN documentation itself bolds (e.g. a button since renamed), the JA translation mirrors EN's own wording — that mismatch is an EN-doc staleness issue, out of scope for a ja-only sync PR.

Note for reviewers: files with mismatched EN/JA bold-span counts were intentionally skipped and are left for a separate pass. A corpus-wide scan for "straddling bracket" defects on the touched files found more candidates, all single-word labels out of this batch's scope; logged for a future 1-word/2-word batch, not fixed here.

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

  • 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

Many bold-wrapped TiDB Cloud web console UI labels (button/tab/field/page
names) were translated into Japanese instead of being kept in English,
inconsistent with how UI strings are usually handled elsewhere in the ja
docs (see maintainer guidance in
pingcap#23455 (comment)).

This restores 467 target 4-word and 3-word UI labels (977 occurrences)
across 135 tidb-cloud/ files (excluding releases/) back to English,
using EN/JA bold-span positional pairing per file, limited to files
where EN and JA bold-span counts matched exactly.

Also fixes several pre-existing MT defects surfaced while auditing the
mechanical fix: stray leftover decoration characters (「」[]) left over
from imprecise bold-span capture, a word-order swap between EN and JA
labels, dropped particles, and one case where the JA bold span covered
far more text than the actual label, causing content loss.

11 files with mismatched EN/JA bold-span counts were intentionally
skipped and are left for a separate pass. A corpus-wide scan for
"straddling bracket" defects (decoration characters split across the
wrong side of ** markers) on the touched files found 133 additional
candidates, all single-word labels out of this batch's scope; logged
for a future 1-word/2-word batch, not fixed here.
@ti-chi-bot

ti-chi-bot Bot commented Aug 13, 2026

Copy link
Copy Markdown

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@ti-chi-bot ti-chi-bot Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 13, 2026
@coderabbitai

coderabbitai Bot commented Aug 13, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f3062a8d-9dc3-43e7-8b9e-ae0704039984

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

@ti-chi-bot

ti-chi-bot Bot commented Aug 13, 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 missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Aug 13, 2026
yahonda added 23 commits August 13, 2026 14:42
…names

The 3/4-word UI-label restoration mechanically treated the literal
Hugo template placeholders {{{ .premium }}} and {{{ .dedicated }}},
as captured from the EN bold span content at those exact positions,
as English UI labels and inserted them verbatim into JA prose,
overwriting the correctly hardcoded product names and, in three
spots, dropping the trailing particle that used to sit inside the
old bold span.
…t Minimum Billing RCU to its translated term
…fied against dbaas-ui source

Audited the part-1 batch (26 files) against the actual TiDB Cloud
console source (tidbcloud/dbaas-ui) to tell literal UI strings apart
from descriptive/marketing prose that EN happens to bold.

Reverted to Japanese where the label is not confirmed literal UI text
(architecture-concepts.md marketing bullets, RU cost-factor headers,
branch/backup/configure-external-storage descriptive headers, etc).

Kept/restored to English where dbaas-ui confirms the exact string is
rendered in the console, including two cases that are dynamically
built from field identifiers rather than literal string constants
(Ignore insert/delete value expression, built via
capitalize(id.replace('_',' ').replace('expr','expression')) in
EventFilter.tsx) and were therefore missed by a naive grep.
…resume, Alibaba/Azure Kafka private-link, and premium encryption docs

Partial audit work from a session that hit its token limit mid-run.
Verified the remaining calls before committing: TiDB Cloud's own pause/resume
dialog title is dynamically 'Pause/Resume {cluster name} cluster', not the
literal 'Pause your cluster' the EN doc bolds, so Japanese is kept. Third-party
AWS/Azure/Alibaba console field names are not in dbaas-ui (TiDB Cloud's own
frontend) by definition; kept the ones that are well-established, stable
console conventions in English and reverted documentation-only category
headers (grouping several real fields under one bold label) to Japanese.
…fied against dbaas-ui source and EN parity

Audited the part-2 batch (26 files: data-service, import, integrate-*,
manage-* docs) against tidbcloud/dbaas-ui and, for third-party consoles
(AWS/Vercel/Zapier/n8n/Airbyte/Postman), general knowledge of their
stable UI conventions.

Reverted marketing/prose bullets and doc-only category headers that
aren't literal console strings. Corrected a few spans where the
mechanical pass had picked the wrong adjacent English phrase for the
position (e.g. data-service-manage-github-connection.md's Connect/
Disconnect toggle button was mislabeled 'Connect to GitHub', which is
actually the area title, not the button — confirmed 1:1 against the
EN source's own 'click **Connect** in the **Connect to GitHub** area'
phrasing).
…grate/monitor/oauth docs, verified against dbaas-ui

Audited the part-3 batch (21 files: migrate-*, monitor-*, oauth2,
premium auditing/export/import docs) against tidbcloud/dbaas-ui and,
for third-party consoles (AWS DMS/IAM, PagerDuty, Slack, Datadog, New
Relic, Alibaba RAM), general knowledge of their stable UI conventions.

Reverted doc-only category headers and unconfirmed spans. Fixed a few
cases where the mechanical pass had scrambled which English label
landed on which position (Datadog/New Relic/Delete mismap in
migrate-metrics-integrations.md; Add Filter Rule/Log Filter Rules
swap in premium/tidb-cloud-auditing-premium.md).

Kept dbaas-ui's exact wording only for confirming whether a span is a
genuine UI label at all; where dbaas-ui's current literal text
differs from what the EN doc itself bolds (e.g. EN bolds 'Choose
migration job type' but the current console tab is labeled
'Migration Type'), mirrored the EN doc's own wording rather than
substitute newer UI copy EN doesn't use — this stays a ja-only sync
fix, not an EN-side accuracy correction.
…curity/recovery-group/private-link/auditing docs

Audited the part-4 batch (27 files: security-concepts, recovery-group-*,
serverless private-link setup across AWS/Azure/GCP/Alibaba, TiDB Cloud
auditing) against tidbcloud/dbaas-ui and third-party console knowledge.

security-concepts.md is fully conceptual/architectural prose (IAM,
projects, encryption overview) with no console walkthrough — reverted
in full, now byte-identical to the pre-automation original.

Fixed word-order/mapping bugs the mechanical pass introduced in
tidb-cloud-auditing(-legacy).md: Log Filter Rules/Add Filter Rule and
Database Audit Logging/Audit Log Access had been swapped onto the
wrong bold spans; corrected to match EN's own step-by-step order.
…ns, verified against dbaas-ui source

Audited the part-5 batch (27 files: billing, budget, clinic, DMS/DM,
console-auditing, import, log-redaction, SSO auth, PoC, quickstart,
roadmap, support, TLS connect, node-group management, TiDB X
architecture/intro, tiproxy, top-ru, chat2query docs) against
tidbcloud/dbaas-ui and third-party console knowledge.

Reverted marketing/architecture-whitepaper prose (tidb-x-architecture.md,
tidb-cloud-intro.md, v8.5-performance-highlights.md are almost entirely
descriptive, not console walkthroughs) and fixed a couple of
field/button mapping swaps (use-chat2query-api.md, tidb-node-group-management.md).

Restored 'Sign in with Google/GitHub/Microsoft' to English rather than
reverting to Japanese: dbaas-ui shows these buttons were renamed to
'Continue with X', but EN's own doc text still says 'Sign in with X' —
per the established rule, ja mirrors EN's own wording exactly; EN's
staleness relative to the live console is a separate, EN-side concern
out of scope for a ja-only sync fix.
…-3 field labels

Fixed missing を particle after `No` in Automatically Accept Endpoint
Connections steps (2 files), and translated the broker-3 Network and
Zone / Instance and Image field labels that were left in English while
their broker-1/broker-2 siblings in the same file were already
correctly translated.
…across PR pingcap#23519's changed lines

Scoped sweep: checked every line changed by the 3/4-word UI-label
restoration batch (git diff fcd3ad0) for **「English label」** where
EN's own doc has no quote decoration, restricted to lines the batch
actually touched (not a blind corpus-wide strip, since 「」 around
Japanese-language UI references elsewhere is often legitimate).
24 sites across 15 files: Amazon S3, Alibaba Cloud OSS, Failover, Add
Credit Card, Add a Card, Add a New Card, Create Custom Budget, Add
alert threshold., Continue with TiDB Account, Upload a local file,
Set Up Authenticator App, Talk to an expert, show example usage (x4),
TiDB Node Group, Chat2Query Data App, Create API Key (x2), Show Code
Example (x2).
…nd during 1:1 EN fluency review

Partial results from a review pass that hit its session limit mid-run:
particle (を/が) restored outside bold spans in 7 files, and a
duplicated stray 'TiDB' word removed in configure-external-storage-access.md.
…ng found during 1:1 EN fluency review

Restored 'Run in Postman for Web' to English (sibling option 'Run in
Postman Desktop' was already correctly restored, this one had been
left in Japanese, EN bolds both). Fixed 'I understand, Delete it' to
match EN's literal button punctuation 'I understand. Delete it'.
… during 1:1 EN fluency review

Removed a leftover '数' suffix glued onto the restored 'Max Messages
per Batch' label (artifact of the old JA term), and added 2 missing
を particles before クリック after Import from S3 / Azure Blob Storage
labels in configure-external-storage-access.md.
…nd during 1:1 EN fluency review

15 fixes across 9 files: particles (の/を/が) moved outside bold spans,
「すべて」closing bracket moved inside its bold span to match EN's
own quoting, a stray duplicated leading word removed, and 3
correctness fixes where the restored English text didn't exactly
match EN's own casing/wording (Create for Dedicated Cluster is
singular in EN despite dbaas-ui's plural Clusters — corrects an
earlier pass that had wrongly substituted dbaas-ui's wording over
EN's own; Set Spending Limit capitalization; Network type - new as
one combined label matching EN's own bold span).
… found during 1:1 EN fluency review

premium/dual-layer-data-encryption-premium.md had a real content bug:
the mechanical pass overwrote the clicked button label (Enable /
有効にする) with a duplicate of the surrounding section name
(Dual-Layer Data Encryption), producing a nonsensical 'in the X
section, click X' sentence; restored to match EN's own 'click
**Enable** in the **Dual-Layer Data Encryption** section' and the
file's own sibling instances. Also fixed a garbled dashboard/が
fragment in monitor-datadog-integration.md, a dropped を particle in
connect-to-premium-via-alibaba-cloud-private-endpoint.md, and Edit
CSV configuration casing in migrate-sql-shards.md to match EN
verbatim.
…during 1:1 EN fluency review

premium/tidb-cloud-tls-connect-to-premium.md had bold-scope creep
where the mechanical pass had bolded an entire trailing clause instead
of just the button label. premium/tidb-cloud-auditing-premium.md had
an untranslated Alibaba Cloud RAM Policy Settings term left in
Japanese while its parallel AWS sentence was correctly restored, plus
a casing fix matching EN's own (inconsistent) 'TiDB Cloud Account Id'
at one specific spot. serverless-private-link-connection-to-self-hosted-kafka-in-alicloud.md
had a correctness bug where 'advertised listener' was wrongly
overwritten with the unrelated 'Kafka Advertised Listener Pattern'
term. Also fixed dropped particles in
premium/migrate-from-op-tidb-premium.md and recovery-group-get-started.md.
…articles found during 1:1 EN fluency review

setup-azure-self-hosted-kafka-private-link-service.md and
setup-self-hosted-kafka-private-service-connect.md had a correctness
bug: 'advertised listener' was wrongly overwritten with 'Kafka
Advertised Listener Pattern', a different bold term from earlier in
the same sentence (same defect class as the alicloud sibling doc,
confirmed against the correct EN section: 'Deploy a new Kafka
cluster' keeps advertised listener unbolded, 'Reconfigure a running
Kafka cluster' bolds it — verified each JA occurrence against its
matching EN section). Also fixed a duplicated 'VPC' word, a broken
bracket/bold split around 'Add subscriptions', a bold cut through the
middle of 'Account ID', and 2 dropped/trapped を particles.
@yahonda
yahonda marked this pull request as ready for review August 14, 2026 05:41
@ti-chi-bot ti-chi-bot Bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Aug 14, 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. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant