Skip to content

i18n(ja): unify configuration file/parameter terminology (part 1/2) - #23832

Open
yahonda wants to merge 2 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-config-3rd-form-part1
Open

i18n(ja): unify configuration file/parameter terminology (part 1/2)#23832
yahonda wants to merge 2 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-config-3rd-form-part1

Conversation

@yahonda

@yahonda yahonda commented Sep 11, 2026

Copy link
Copy Markdown
Member

First-time contributors' checklist

What is changed, added or deleted? (Required)

Part 1/2 of #23828, split to stay under CodeRabbit's 150-file review limit (the original branch grew to 265 files across 7 review-driven follow-up commits). This PR contains 133 of those files; part 2/2 is #23833 with the remaining 132. Both parts are byte-identical to #23828's final content for their respective file subsets — verified via a SHA comparison against every file in both splits.

Unifies the multi-way split rendering of "configuration" (file, parameter, item, flag, option, and other compounds, plus standalone/bare use) across the corpus, consistent with the already-decided direction for configuration item/parameter/option compounds (PR #23596). Also includes several literal-identifier and false-friend fixes found during review of #23828 (Grafana/TiDB Dashboard UI labels wrongly translated to Japanese, a config-item key mistranslated as prose instead of kept literal, a mistranslated table header, more natural table header wording).

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)?

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
    • Standardized Japanese configuration-related terminology across navigation, guides, reference pages, and release notes.
    • Updated headings, table labels, link text, summaries, and descriptions to use consistent “設定” and “設定ファイル” wording.
    • Preserved existing links, anchors, procedures, examples, and technical content.
    • Clarified terminology across TiDB, TiKV, PD, TiDB Data Migration, deployment, monitoring, benchmarking, and integration documentation.
    • No functional behavior or configuration semantics were changed.

Split from a single branch that grew past CodeRabbit's 150-file
review limit (265 files total). This is part 1/2, containing 133 of
those files; part 2/2 is a separate PR with the remaining 132 files.
Both parts are byte-identical to the original branch's content for
their respective file subsets.

Unifies the multi-way split rendering of "configuration" (file,
parameter, item, flag, option, and other compounds, plus standalone/
bare use) across the corpus, consistent with the already-decided
direction for configuration item/parameter/option compounds (PR
pingcap#23596). Also includes several literal-identifier and false-friend
fixes found during review (Grafana/TiDB Dashboard UI labels wrongly
translated, a config-item key mistranslated as prose, a mistranslated
table header, more natural table headers).

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@ti-chi-bot ti-chi-bot Bot added the area/develop This PR relates to the area of TiDB App development. label Sep 11, 2026
@ti-chi-bot

ti-chi-bot Bot commented Sep 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 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/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Sep 11, 2026
@coderabbitai

coderabbitai Bot commented Sep 11, 2026

Copy link
Copy Markdown

Review Change StackReview 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: Advanced

Run ID: 5813fb97-43b9-4e3f-87b2-6dcea093a5b7

📥 Commits

Reviewing files that changed from the base of the PR and between f247efd and 44f780a.

📒 Files selected for processing (4)
  • dm/deploy-a-dm-cluster-using-tiup-offline.md
  • dm/dm-precheck.md
  • releases/release-2.0.4.md
  • releases/release-6.4.0.md

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


📝 Walkthrough

Walkthrough

This documentation-only change standardizes Japanese configuration terminology as 設定 or 設定ファイル across navigation, operational guides, DM documentation, migration content, and release notes. Links and anchors remain unchanged in most updates.

Changes

Documentation terminology standardization

Layer / File(s) Summary
Navigation and reference terminology
TOC*.md, _index.md, command-line-flags-*.md, dynamic-config.md, pd-configuration-file.md, dashboard/*
Japanese navigation labels, headings, table headers, and reference text use standardized settings terminology.
Operations and migration terminology
ai/integrations/*, benchmark/*, best-practices/*, br/*, clinic/*, develop/*, encryption-at-rest.md, migrate-*.md, *deployment*.md
Operational, security, topology, migration, and integration documentation updates configuration-related wording without changing procedures or technical content.
DM documentation terminology
dm/*
DM documentation updates configuration-related wording. The relay-log documentation also clarifies recovery behavior for specified binlog names and GTIDs.
Release-note terminology
releases/*
Release-note summaries, headings, tables, and descriptions use standardized settings terminology. One TiKV documentation link anchor is updated.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~15 minutes

Merge Risk: 🟡 Moderate · up to 44f78

Several changed Japanese documentation pages can still mislead users or direct them to unavailable or incorrect references. These documentation issues should be corrected before merge.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the Japanese internationalization change and the terminology unification scope. It also notes that this is part 1 of 2.
Description check ✅ Passed The description is complete and relevant. It explains the scope, rationale, split-PR context, affected documentation version, related PRs, AI involvement, and change categories. The first-time contrib…
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.
✨ 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: 11


ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: f095badd-090d-4c6d-9225-2fbd14c61b61

📥 Commits

Reviewing files that changed from the base of the PR and between 645c2ff and f247efd.

📒 Files selected for processing (133)
  • TOC-tidb-cloud-essential.md
  • TOC-tidb-cloud-starter.md
  • TOC-tidb-cloud.md
  • TOC.md
  • _index.md
  • ai/integrations/tidb-mcp-server.md
  • benchmark/benchmark-tidb-using-sysbench.md
  • benchmark/v3.0-performance-benchmarking-with-sysbench.md
  • best-practices/haproxy-best-practices.md
  • best-practices/three-nodes-hybrid-deployment.md
  • best-practices/tidb-partitioned-tables-best-practices.md
  • br/backup-and-restore-storages.md
  • br/br-monitoring-and-alert.md
  • cached-tables.md
  • check-before-deployment.md
  • clinic/clinic-data-instruction-for-tiup.md
  • clinic/clinic-introduction.md
  • clinic/clinic-user-guide-for-tiup.md
  • command-line-flags-for-pd-configuration.md
  • command-line-flags-for-scheduling-configuration.md
  • command-line-flags-for-tidb-configuration.md
  • command-line-flags-for-tikv-configuration.md
  • command-line-flags-for-tso-configuration.md
  • configure-placement-rules.md
  • coprocessor-cache.md
  • dashboard/dashboard-diagnostics-report.md
  • dashboard/dashboard-faq.md
  • dashboard/dashboard-ops-reverse-proxy.md
  • dashboard/dashboard-resource-manager.md
  • deploy-monitoring-services.md
  • develop/dev-guide-aws-appflow-integration.md
  • develop/dev-guide-insert-data.md
  • develop/dev-guide-optimistic-and-pessimistic-transaction.md
  • develop/dev-guide-prepared-statement.md
  • develop/dev-guide-proxysql-integration.md
  • develop/dev-guide-third-party-tools-compatibility.md
  • dm/deploy-a-dm-cluster-using-binary.md
  • dm/deploy-a-dm-cluster-using-tiup-offline.md
  • dm/deploy-a-dm-cluster-using-tiup.md
  • dm/dm-best-practices.md
  • dm/dm-binlog-event-filter.md
  • dm/dm-block-allow-table-lists.md
  • dm/dm-config-overview.md
  • dm/dm-continuous-data-validation.md
  • dm/dm-customized-secret-key.md
  • dm/dm-enable-tls.md
  • dm/dm-export-import-config.md
  • dm/dm-faq.md
  • dm/dm-generate-self-signed-certificates.md
  • dm/dm-glossary.md
  • dm/dm-handle-performance-issues.md
  • dm/dm-hardware-and-software-requirements.md
  • dm/dm-manage-source.md
  • dm/dm-master-configuration-file.md
  • dm/dm-online-ddl-tool-support.md
  • dm/dm-open-api.md
  • dm/dm-precheck.md
  • dm/dm-source-configuration-file.md
  • dm/dm-task-configuration-guide.md
  • dm/dm-tune-configuration.md
  • dm/dm-worker-configuration-file.md
  • dm/feature-shard-merge-optimistic.md
  • dm/feature-shard-merge.md
  • dm/maintain-dm-using-tiup.md
  • dm/manually-handling-sharding-ddl-locks.md
  • dm/manually-upgrade-dm-1.0-to-2.0.md
  • dm/migrate-data-using-dm.md
  • dm/quick-start-create-source.md
  • dm/quick-start-create-task.md
  • dm/quick-start-with-dm.md
  • dm/relay-log.md
  • dm/task-configuration-file-full.md
  • dm/usage-scenario-master-slave-switch.md
  • dr-multi-replica.md
  • dynamic-config.md
  • enable-disk-spill-encrypt.md
  • enable-tls-between-clients-and-servers.md
  • encryption-at-rest.md
  • explain-joins.md
  • faq/high-reliability-faq.md
  • filter-binlog-event.md
  • filter-dml-event.md
  • garbage-collection-configuration.md
  • generate-self-signed-certificates.md
  • geo-distributed-deployment-topology.md
  • get-started-with-tidb-lightning.md
  • hybrid-deployment-topology.md
  • information-schema/information-schema-inspection-result.md
  • maintain-tidb-using-tiup.md
  • migrate-aurora-to-tidb.md
  • migrate-from-csv-files-to-tidb.md
  • migrate-from-sql-files-to-tidb.md
  • migrate-from-tidb-to-mysql.md
  • migrate-from-tidb-to-tidb.md
  • migrate-from-vitess.md
  • migrate-large-mysql-shards-to-tidb.md
  • migrate-large-mysql-to-tidb.md
  • migrate-small-mysql-shards-to-tidb.md
  • migrate-small-mysql-to-tidb.md
  • migrate-with-more-columns-downstream.md
  • migrate-with-pt-ghost.md
  • minimal-deployment-topology.md
  • multi-data-centers-in-one-city-deployment.md
  • pd-configuration-file.md
  • pd-microservices-deployment-topology.md
  • performance-tuning-overview.md
  • production-deployment-using-tiup.md
  • quick-start-with-tidb.md
  • releases/release-2.0-ga.md
  • releases/release-2.0-rc.1.md
  • releases/release-2.0-rc.3.md
  • releases/release-2.0.4.md
  • releases/release-2.1.1.md
  • releases/release-2.1.16.md
  • releases/release-2.1.17.md
  • releases/release-2.1.18.md
  • releases/release-3.0.2.md
  • releases/release-3.0.4.md
  • releases/release-3.1.0-beta.2.md
  • releases/release-4.0-ga.md
  • releases/release-4.0.0-beta.1.md
  • releases/release-4.0.3.md
  • releases/release-5.0.0.md
  • releases/release-5.1.0.md
  • releases/release-5.2.0.md
  • releases/release-5.3.0.md
  • releases/release-5.4.0.md
  • releases/release-6.0.0-dmr.md
  • releases/release-6.1.0.md
  • releases/release-6.1.4.md
  • releases/release-6.2.0.md
  • releases/release-6.3.0.md
  • releases/release-6.4.0.md

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

Comment thread _index.md
Comment thread br/backup-and-restore-storages.md
Comment thread clinic/clinic-user-guide-for-tiup.md
Comment thread deploy-monitoring-services.md
Comment thread dm/deploy-a-dm-cluster-using-tiup-offline.md Outdated
Comment thread dm/dm-precheck.md Outdated
Comment thread filter-binlog-event.md
Comment thread releases/release-2.0.4.md Outdated
Comment thread releases/release-6.1.4.md
Comment thread releases/release-6.4.0.md Outdated
- deploy-a-dm-cluster-using-tiup-offline.md: repair garbled template-reference sentence
- dm-precheck.md: fix swapped mydumpers/threads relationship
- release-2.0.4.md: complete 構成→設定 unification within the same bullet
- release-6.4.0.md: repair garbled TiFlash SM4 encryption sentence
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/develop This PR relates to the area of TiDB App development. 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