Skip to content

i18n(ja): restore literal config-key identifiers and filename templates - #23726

Merged
qiancai merged 6 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-ja-literal-config-identifiers
Sep 4, 2026
Merged

i18n(ja): restore literal config-key identifiers and filename templates#23726
qiancai merged 6 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-ja-literal-config-identifiers

Conversation

@yahonda

@yahonda yahonda commented Sep 3, 2026

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Found while sweeping for the "literal identifier translated into Japanese" defect class corpus-wide, extending previous sweeps (dotted config/API identifiers, S3 API action names, MySQL/TiDB privilege names — see prior PRs #23617-#23623, #23715, #23716). This round specifically targeted fully-katakana-translated dotted identifiers, a shape invisible to the ASCII-vs-katakana regex used in earlier sweeps.

  • tiflash/tiflash-configuration.md: 15 #### heading identifiers (literal TOML config-section names users type into tiflash.toml/tiflash-learner.toml, e.g. flash, security.encryption.master-key) were rendered in katakana/kanji instead of literal — inconsistent with correctly-untouched sibling headings like storage.main in the same file.
  • ticdc/ticdc-changefeed-config.md: 3 heading identifiers (filter.event-filters, sink.open, sink.debezium).
  • tidb-lightning/tidb-lightning-requirements.md: checkpoint.driver = "mysql" config value in a privilege-requirement table.
  • releases/release-6.2.0.md: 2 log-backup.* config-key link texts.
  • tidb-cloud/premium/premium-export.md: filename-template placeholders ({database}, {table}, .{compression-type}) in a naming-convention table — these are substituted literally by the export tool.

Each fix verified against the EN source (release-8.5) at the same location.

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

Summary by CodeRabbit

  • Documentation
    • Updated Japanese documentation to use English configuration names for TiKV log backup, TiCDC, TiFlash, and TiDB Lightning settings.
    • Standardized export filename tables with English headers and placeholders for databases, tables, and compression types.
    • Corrected the TiCDC Canal-JSON terminology.
    • Clarified the YCSB go-ycsb workloada reference and updated its comparison table.
    • Preserved existing configuration values, anchors, and documented naming patterns.

@ti-chi-bot

ti-chi-bot Bot commented Sep 3, 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 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

@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Team

Run ID: a1ba921e-d0af-458b-8180-966a3901f265

📥 Commits

Reviewing files that changed from the base of the PR and between ff8d870 and 13b0471.

📒 Files selected for processing (1)
  • ticdc/ticdc-canal-json.md

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


📝 Walkthrough

Walkthrough

This documentation update replaces selected Japanese labels with English configuration names, standardizes export filename placeholders, corrects one schema filename pattern, and updates terminology in comparison and benchmark tables. Existing anchors, descriptions, values, and links remain unchanged.

Changes

Documentation terminology alignment

Layer / File(s) Summary
Configuration and heading identifiers
releases/release-6.2.0.md, ticdc/ticdc-changefeed-config.md, tidb-lightning/tidb-lightning-requirements.md, tiflash/tiflash-configuration.md
Configuration links, section headings, and the checkpoint permission example now use English configuration identifiers. Existing anchors and descriptions remain unchanged.
Export filename conventions
tidb-cloud/premium/premium-export.md, tidb-cloud/serverless-export.md
Export tables now use English headers and standardized {database}, {table}, and {compression-type} placeholders. The premium schema filename pattern is corrected.
Reference table terminology
ticdc/ticdc-canal-json.md, tidb-performance-tuning-config.md
The Canal comparison and Update-event labels, plus the YCSB workload label, now use updated terminology. Benchmark values remain unchanged.

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

Merge Risk: ⚪ Minimal · up to 13b04

This change standardizes Japanese table and update-event terminology without altering documented behavior, configuration, links, or values. No current merge-readiness risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: restoring literal configuration-key identifiers and filename templates in the Japanese documentation.
Description check ✅ Passed The description explains the changes, affected files, target version, and AI involvement. The related-link fields are empty, but they are non-critical because no source or reference links are required…
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.
Full details: Description check

Explanation

The description explains the changes, affected files, target version, and AI involvement. The related-link fields are empty, but they are non-critical because no source or reference links are required to understand this documentation-only change.

Full details: Docstring Coverage

Explanation

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 files. (1 skipped: 1 unsupported.)

✨ 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.

@ti-chi-bot ti-chi-bot Bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Sep 3, 2026
@yahonda
yahonda force-pushed the fix-ja-literal-config-identifiers branch from 34262fe to a8d0873 Compare September 3, 2026 07:24
TOML config-section headings, dotted config keys, and filename-template
placeholders are literal strings users type into config files or match
against tool output — translating them breaks that exact-match property.

- tiflash/tiflash-configuration.md: 15 heading identifiers (e.g. flash,
  security.encryption.master-key) rendered in katakana/kanji instead of
  literal, inconsistent with correctly-untouched sibling headings like
  storage.main in the same file.
- ticdc/ticdc-changefeed-config.md: 3 heading identifiers (filter.event-filters,
  sink.open, sink.debezium).
- tidb-lightning/tidb-lightning-requirements.md: checkpoint.driver config
  value in a privilege table.
- releases/release-6.2.0.md: 2 log-backup.* config-key link texts.
- tidb-cloud/premium/premium-export.md: filename-template placeholders
  ({database}, {table}, compression-type) in a naming-convention table.
@yahonda
yahonda force-pushed the fix-ja-literal-config-identifiers branch from a8d0873 to d9b5dd9 Compare September 3, 2026 07:25
…er gap

- Unify "Item" table-header translation to 項目 across 4 files (was
  アイテム, an inconsistent minority form vs the dominant convention
  once compared across the corpus).
- premium-export.md/serverless-export.md: also fix 圧縮/圧縮されている
  header pair not being grammatically parallel with 圧縮されていない.
- serverless-export.md: same literal-identifier defect as
  premium-export.md's naming-convention table (missed by the earlier
  scan since this sibling file wasn't in its initial file list).
The table row translated "Workloada" (the literal go-ycsb benchmark
workload name referenced two paragraphs earlier) as the generic noun
作業負荷 ("workload"), losing the fact that it names one specific
benchmark preset.
Same defect as the table row fixed in the previous commit: the link
text "go-ycsb workloada" (matching the URL's own /workloads/workloada
path) was genericized to "go-ycsbワークロード", losing the specific
benchmark identifier.
Missing connector between the identifier and 追加パラメーター made
the sentence read as an unnatural direct juxtaposition; EN's "has an
extra `X` parameter" needs という to connect the identifier to the
noun phrase naturally.
EN consistently says "Event of Update Type"; JA had split into タイプ
(heading, one bullet) and 種類 (table row, one paragraph) within the
same file.
@qiancai qiancai added translation/no-need No need to translate this PR. and removed missing-translation-status This PR does not have translation status info. labels Sep 4, 2026
@qiancai
qiancai merged commit 32de109 into pingcap:i18n-ja-release-8.5 Sep 4, 2026
5 of 9 checks passed
@ti-chi-bot ti-chi-bot Bot added the needs-1-more-lgtm Indicates a PR needs 1 more LGTM. label Sep 4, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 4, 2026

Copy link
Copy Markdown

[LGTM Timeline notifier]

Timeline:

  • 2026-09-04 12:22:30.792253527 +0000 UTC m=+1454785.963347633: ☑️ agreed by qiancai.

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. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. translation/no-need No need to translate this PR.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants