Skip to content

i18n(ja): use one rendering for compaction in the reference docs (part 1) - #24200

Open
yahonda wants to merge 5 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-ja-compaction-term-part1
Open

yahonda wants to merge 5 commits into
pingcap:i18n-ja-release-8.5from
yahonda:fix-ja-compaction-term-part1

Conversation

@yahonda

@yahonda yahonda commented Oct 7, 2026 •

Copy link
Copy Markdown
Member

What is changed, added or deleted? (Required)

Renders "compaction" (RocksDB/TiKV/TiFlash compaction) as コンパクション instead of 圧縮 in the reference docs. 圧縮 is the established Japanese word for "compression", so using it for compaction made sentences like 「圧縮方法」 (EN "Compaction method") or 「保留中の圧縮バイト」 (EN "pending compaction bytes") read as if they were about data compression. コンパクション is already used in the JA docs, for example in コンパクションフィルター.

This is part 1 (29 files, non-release docs). The release notes will follow in a separate PR after the open release-note PRs are merged. storage-engine/ is not included because #24142 already covers it.

How each site was chosen

  • Each 圧縮 site was decided from its EN text, not from the Japanese word form.
  • Files whose EN uses only "compress/compression" were skipped.
  • For the remaining files, each 圧縮 line was matched with its EN line. If the EN line says compaction/compact/compacted, the site was changed; if it says compress/compression, it was kept.
  • Lines that could not be matched automatically were checked by hand.

Kept as 圧縮 because EN says "compress":

  • dm/dm-replication-logic.md: "compress multiple changes into one change".
  • faq/manage-cluster-faq.md: "compressed by TiKV".
  • storage-engine/ lines: not touched.
  • tidb-lightning/monitor-tidb-lightning.md: 非圧縮 ("uncompressed").
  • troubleshoot-high-disk-io.md: 圧縮率の高い圧縮アルゴリズム ("compression algorithm").
  • tikv-configuration-file.md (max-bytes-for-level-base): this line mixes both meanings. Only 「不要な圧縮」 and 「L0 の圧縮のトリガー条件」 (compaction) were changed; 「圧縮方法」, 「圧縮されず」, 「圧縮を採用」, and 「圧縮された SST」 (compression) were kept.

Configuration names and code are unchanged.

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

Tips for choosing the affected version(s):

By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.

For details, see tips for choosing the affected versions.

  • 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

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Standardized Japanese terminology for compaction across TiKV, TiFlash, RocksDB, and related configuration, operations, monitoring, troubleshooting, and performance guides.
    • Clarified the TI_TELEMETRY_EXTRA size limit and selected configuration descriptions, including flow-control thresholds and backup backend selection. Documented settings and behavior are otherwise unchanged.

@yahonda
yahonda force-pushed the fix-ja-compaction-term-part1 branch from 2cac184 to d55733c Compare October 7, 2026 00:13
@yahonda yahonda changed the title i18n(ja): use コンパクション for compaction in the reference docs (part 1) i18n(ja): use the katakana term for compaction in the reference docs (part 1) Oct 7, 2026
@ti-chi-bot ti-chi-bot Bot added the missing-translation-status This PR does not have translation status info. label Oct 7, 2026
@ti-chi-bot

ti-chi-bot Bot commented Oct 7, 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 the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Oct 7, 2026
…t 1)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@yahonda
yahonda force-pushed the fix-ja-compaction-term-part1 branch from d55733c to 7ca8164 Compare October 7, 2026 00:14
@yahonda yahonda changed the title i18n(ja): use the katakana term for compaction in the reference docs (part 1) i18n(ja): use one rendering for compaction in the reference docs (part 1) Oct 7, 2026
@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in 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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 4183ef9f-00f9-4b99-859a-12ea263b2d41
📥 Commits

Reviewing files that changed from the base of the PR and between 2c12bf7 and 5cd2f78.

📒 Files selected for processing (1)
  • tikv-configuration-file.md

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


📝 Walkthrough

Walkthrough

The documentation updates compaction terminology across TiKV, TiFlash, and related topics. The TiKV configuration guide also adds gc.auto-compaction details and clarifies flow-control threshold overrides.

Changes

Compaction terminology

Layer / File(s) Summary
TiKV settings and control
dynamic-config.md, garbage-collection-configuration.md, pd-configuration-file.md, tikv-configuration-file.md, tikv-control.md
TiKV configuration and control descriptions use compaction terminology. The configuration guide adds gc.auto-compaction details and clarifies flow-control threshold overrides.
Operations and performance guidance
best-practices/*, faq/manage-cluster-faq.md, performance-tuning-methods.md, tidb-performance-tuning-config.md, tidb-troubleshooting-map.md, troubleshoot-high-disk-io.md, tune-tikv-thread-performance.md, tidb-lightning/data-import-best-practices.md
Best-practice, performance, and troubleshooting descriptions use compaction terminology. Recommendations and parameter values remain unchanged.
SQL, backup, and import operations
br/br-compact-log-backup.md, sql-statements/sql-statement-alter-table-compact.md, tidb-lightning/*
Log backup, SQL compaction, and TiDB Lightning documentation uses compaction terminology. Command examples and documented operation conditions remain unchanged.
Monitoring and related references
ai/ti/reference/ti-configuration-and-credentials.md, dashboard/dashboard-monitoring.md, encryption-at-rest.md, faq/sql-faq.md, grafana-tikv-dashboard.md, tiflash/*, tiflash-upgrade-guide.md
Monitoring, encryption, FAQ, telemetry, and TiFlash descriptions use compaction terminology. The TI_TELEMETRY_EXTRA size description specifies a 2 KiB maximum after JSON compaction.

Priority: ➖ Normal

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

Change: Other

Suggested reviewers: qiancai

Merge Risk: ⚪ Minimal · up to 5cd2f

The documentation changes are consistent with the available reference and implementation evidence; no concrete issue remains that should block merging.

Architecture Summary

Architecture risk: 🔵 Low · up to 5cd2f

The change affects 21 systems.

Changed systems: tidb-lightning, tiflash, best-practices, faq, ai, br, dashboard, dynamic-config.md, encryption-at-rest.md, garbage-collection-configuration.md, grafana-tikv-dashboard.md, pd-configuration-file.md, performance-tuning-methods.md, sql-statements, tidb-performance-tuning-config.md, tidb-troubleshooting-map.md, tiflash-upgrade-guide.md, tikv-configuration-file.md, tikv-control.md, troubleshoot-high-disk-io.md, tune-tikv-thread-performance.md

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — tidb-lightning (service) was modified; 4 changed files map to changed impact.
  • observed — tiflash (service) was modified; 4 changed files map to changed impact.
  • observed — best-practices (service) was modified; 2 changed files map to changed impact.
  • observed — faq (service) was modified; 2 changed files map to changed impact.

Before / after behavior

  • observed — Modified behavior in best-practices/best-practices-on-public-cloud.md: 見出しの「圧縮 I/O フロー」を「コンパクション I/O フロー」に変更しました。
  • observed — Modified behavior in best-practices/best-practices-on-public-cloud.md: 平均行サイズが 512 バイトより大きい場合の Titan 設定について、説明中の「圧縮 I/O フロー」を「コンパクション I/O フロー」に変更しました。設定値と適用条件は変わっていません。
  • observed — Modified behavior in best-practices/three-nodes-hybrid-deployment.md: rocksdb.max-sub-compactionsの説明で、単一ジョブの用語を「圧縮ジョブ」から「コンパクションジョブ」に変更しました。デフォルト値と、書き込み負荷が高くない場合に値を下げられるという説明は維持されています。
  • observed — Modified behavior in best-practices/three-nodes-hybrid-deployment.md: rocksdb.rate-bytes-per-secの説明で、「バックグラウンド圧縮ジョブ」を「バックグラウンドコンパクションジョブ」に変更しました。帯域制限の説明は維持されています。
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the Japanese documentation terminology change for compaction and indicates that this is part 1.
Description check ✅ Passed The description explains the terminology change, its rationale and scope, the affected documentation branch, and related reference information. It also addresses AI involvement and the applicable chec…
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 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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: 1


ℹ️ Review info
⚙️ Run configuration
  • Configuration used: Repository: pingcap/docs/.coderabbit.yaml
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 665b3282-0a00-4e89-bd6f-b2fae9b58346
📥 Commits

Reviewing files that changed from the base of the PR and between a4dfec7 and 7ca8164.

📒 Files selected for processing (29)
  • ai/ti/reference/ti-configuration-and-credentials.md
  • best-practices/best-practices-on-public-cloud.md
  • best-practices/three-nodes-hybrid-deployment.md
  • br/br-compact-log-backup.md
  • dashboard/dashboard-monitoring.md
  • dynamic-config.md
  • encryption-at-rest.md
  • faq/manage-cluster-faq.md
  • faq/sql-faq.md
  • garbage-collection-configuration.md
  • grafana-tikv-dashboard.md
  • pd-configuration-file.md
  • performance-tuning-methods.md
  • sql-statements/sql-statement-alter-table-compact.md
  • tidb-lightning/data-import-best-practices.md
  • tidb-lightning/import-into-vs-tidb-lightning.md
  • tidb-lightning/tidb-lightning-command-line-full.md
  • tidb-lightning/tidb-lightning-glossary.md
  • tidb-performance-tuning-config.md
  • tidb-troubleshooting-map.md
  • tiflash-upgrade-guide.md
  • tiflash/monitor-tiflash.md
  • tiflash/tiflash-configuration.md
  • tiflash/tune-tiflash-performance.md
  • tiflash/use-fastscan.md
  • tikv-configuration-file.md
  • tikv-control.md
  • troubleshoot-high-disk-io.md
  • tune-tikv-thread-performance.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

Comment thread ai/ti/reference/ti-configuration-and-credentials.md Outdated
yahonda and others added 4 commits October 7, 2026 09:45
…he ti credentials reference

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…d doc

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…ard doc

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…sholds

Co-Authored-By: Claude Opus 5.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/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant