fix: update custom content tags to use proper casing in documentation#22682
fix: update custom content tags to use proper casing in documentation#22682shhdgit wants to merge 1 commit intoi18n-ja-release-8.5from
Conversation
- Changed <customcontent> to <CustomContent> in multiple markdown files for consistency and adherence to formatting standards. - Updated migration, integration, and performance tuning documents to reflect the changes in custom content tags. - Ensured that all instances of custom content are correctly formatted across various sections of the documentation.
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Code Review
This pull request standardizes the capitalization of the <CustomContent> tag across multiple Japanese documentation files and removes minor trailing whitespace. The review feedback identifies several opportunities to improve the Japanese text, including correcting grammatically incomplete sentences, ensuring consistent terminology for 'cluster' and 'instance', and refining sentence structures for better clarity and readability.
| > **注記:** | ||
| > | ||
| > - 現在、 TiDB Cloud、1アカウントあたり最大100件の変更フィードしか許可されていません。<customcontent plan="dedicated">クラスタ</customcontent><customcontent plan="premium">実例</customcontent>。 | ||
| > - 現在、 TiDB Cloud、1アカウントあたり最大100件の変更フィードしか許可されていません。<CustomContent plan="dedicated">クラスタ</CustomContent><CustomContent plan="premium">実例</CustomContent>。 |
There was a problem hiding this comment.
The sentence structure is awkward and uses inconsistent terminology. "クラスタ" should be "クラスター" and "実例" should be "インスタンス" to align with TiDB documentation standards. Additionally, using active voice ("作成できます") is preferred over passive voice ("許可されていません") for better readability.
| > - 現在、 TiDB Cloud、1アカウントあたり最大100件の変更フィードしか許可されていません。<CustomContent plan="dedicated">クラスタ</CustomContent><CustomContent plan="premium">実例</CustomContent>。 | |
| > - 現在、TiDB Cloudでは、<CustomContent plan= |
| ### ネットワーク {#network} | ||
|
|
||
| TiDBが<customcontent plan="dedicated">クラスタ</customcontent><customcontent plan="premium">実例</customcontent>Apache Kafka サービスに接続できます。以下の接続方法のいずれかを選択できます。 | ||
| TiDBが<CustomContent plan="dedicated">クラスタ</CustomContent><CustomContent plan="premium">実例</CustomContent>Apache Kafka サービスに接続できます。以下の接続方法のいずれかを選択できます。 |
There was a problem hiding this comment.
The sentence is grammatically incomplete and uses inconsistent terminology. It should clearly state that the cluster or instance needs to be able to connect to the service.
| TiDBが<CustomContent plan="dedicated">クラスタ</CustomContent><CustomContent plan="premium">実例</CustomContent>Apache Kafka サービスに接続できます。以下の接続方法のいずれかを選択できます。 | |
| <CustomContent plan="dedicated">TiDBクラスター</CustomContent><CustomContent plan="premium">TiDBインスタンス</CustomContent>がApache Kafkaサービスに接続できることを確認してください。以下の接続方法のいずれかを選択できます。 |
| ## ステップ4. チェンジフィード仕様を構成する {#step-4-configure-your-changefeed-specification} | ||
|
|
||
| 1. **チェンジフィード仕様**エリアで、<customcontent plan="dedicated">レプリケーション容量単位(RCU)</customcontent><customcontent plan="premium">チェンジフィード容量単位(CCU)</customcontent>チェンジフィードによって使用されます。 | ||
| 1. **チェンジフィード仕様**エリアで、<CustomContent plan="dedicated">レプリケーション容量単位(RCU)</CustomContent><CustomContent plan="premium">チェンジフィード容量単位(CCU)</CustomContent>チェンジフィードによって使用されます。 |
There was a problem hiding this comment.
The sentence is grammatically incomplete as it lacks a verb to instruct the user. It should explicitly tell the user to select the RCU or CCU.
| 1. **チェンジフィード仕様**エリアで、<CustomContent plan="dedicated">レプリケーション容量単位(RCU)</CustomContent><CustomContent plan="premium">チェンジフィード容量単位(CCU)</CustomContent>チェンジフィードによって使用されます。 | |
| 1. **[チェンジフィード仕様]**エリアで、変更フィードで使用する<CustomContent plan="dedicated">レプリケーション容量単位 (RCU)</CustomContent><CustomContent plan="premium">チェンジフィード容量単位 (CCU)</CustomContent>を選択します。 |
| # ユーザー制御のログ編集 {#user-controlled-log-redaction} | ||
|
|
||
| ユーザー制御のログ編集により、機密データの可視性を管理できます。<customcontent plan="dedicated"> [TiDB Cloud専用](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated)クラスター</customcontent><customcontent plan="premium">TiDB Cloud Premiumインスタンス</customcontent>ログ。この編集機能を切り替えることで、情報を保護し、運用上のニーズとセキュリティのバランスを取り、ログに表示される内容を制御できます。<customcontent plan="dedicated">クラスタ</customcontent><customcontent plan="premium">実例</customcontent>ログ。 | ||
| ユーザー制御のログ編集により、機密データの可視性を管理できます。<CustomContent plan="dedicated"> [TiDB Cloud専用](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated)クラスター</CustomContent><CustomContent plan="premium">TiDB Cloud Premiumインスタンス</CustomContent>ログ。この編集機能を切り替えることで、情報を保護し、運用上のニーズとセキュリティのバランスを取り、ログに表示される内容を制御できます。<CustomContent plan="dedicated">クラスタ</CustomContent><CustomContent plan="premium">実例</CustomContent>ログ。 |
There was a problem hiding this comment.
The sentence structure is broken, making it difficult to read. Terminology should also be updated for consistency ("クラスター" and "インスタンス").
| ユーザー制御のログ編集により、機密データの可視性を管理できます。<CustomContent plan="dedicated"> [TiDB Cloud専用](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated)クラスター</CustomContent><CustomContent plan="premium">TiDB Cloud Premiumインスタンス</CustomContent>ログ。この編集機能を切り替えることで、情報を保護し、運用上のニーズとセキュリティのバランスを取り、ログに表示される内容を制御できます。<CustomContent plan="dedicated">クラスタ</CustomContent><CustomContent plan="premium">実例</CustomContent>ログ。 | |
| ユーザー制御のログ編集により、<CustomContent plan="dedicated">[TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated)クラスター</CustomContent><CustomContent plan="premium">TiDB Cloud Premiumインスタンス</CustomContent>のログに含まれる機密データの可視性を管理できます。この編集機能を切り替えることで、情報を保護し、運用上のニーズとセキュリティのバランスを取りながら、<CustomContent plan="dedicated">クラスター</CustomContent><CustomContent plan="premium">インスタンス</CustomContent>のログに表示される内容を制御できます。 |
| </CustomContent> | ||
|
|
||
| 1. 対象のTiDBの[**チェンジフィード**](#view-the-changefeed-page)ページ目に移動します<customcontent plan="dedicated">クラスタ</customcontent><customcontent plan="premium">実例</customcontent>。 | ||
| 1. 対象のTiDBの[**チェンジフィード**](#view-the-changefeed-page)ページ目に移動します<CustomContent plan="dedicated">クラスタ</CustomContent><CustomContent plan="premium">実例</CustomContent>。 |
There was a problem hiding this comment.
"ページ目に移動します" is unnatural phrasing in Japanese. It should be "ページに移動します". Also, please update the terminology for consistency ("クラスター" and "インスタンス").
| 1. 対象のTiDBの[**チェンジフィード**](#view-the-changefeed-page)ページ目に移動します<CustomContent plan="dedicated">クラスタ</CustomContent><CustomContent plan="premium">実例</CustomContent>。 | |
| 1. 対象の<CustomContent plan="dedicated">クラスター</CustomContent><CustomContent plan="premium">インスタンス</CustomContent>の[**チェンジフィード**](#view-the-changefeed-page)ページに移動します。 |
| # TiDB Xアーキテクチャ {#tidb-x-architecture} | ||
|
|
||
| TiDB Xは、クラウドネイティブのオブジェクトstorageをTiDBのバックボーンとする新しい分散SQLアーキテクチャです。現在、 TiDB Cloudで利用可能です。<customcontent plan="starter,essential,dedicated">スターターとエッセンシャル</customcontent><customcontent plan="premium">スターター、エッセンシャル、プレミアム</customcontent>このアーキテクチャにより、AI 時代のワークロードに対して、弾力的なスケーラビリティ、予測可能なパフォーマンス、最適化された総所有コスト (TCO) が実現します。 | ||
| TiDB Xは、クラウドネイティブのオブジェクトstorageをTiDBのバックボーンとする新しい分散SQLアーキテクチャです。現在、 TiDB Cloudで利用可能です。<CustomContent plan="starter,essential,dedicated">スターターとエッセンシャル</CustomContent><CustomContent plan="premium">スターター、エッセンシャル、プレミアム</CustomContent>このアーキテクチャにより、AI 時代のワークロードに対して、弾力的なスケーラビリティ、予測可能なパフォーマンス、最適化された総所有コスト (TCO) が実現します。 |
There was a problem hiding this comment.
Please use consistent terminology for "storage" (ストレージ) and "cluster/instance" (クラスター/インスタンス). Also, "Starter" and "Essential" are typically kept in English in TiDB Cloud documentation.
| TiDB Xは、クラウドネイティブのオブジェクトstorageをTiDBのバックボーンとする新しい分散SQLアーキテクチャです。現在、 TiDB Cloudで利用可能です。<CustomContent plan="starter,essential,dedicated">スターターとエッセンシャル</CustomContent><CustomContent plan="premium">スターター、エッセンシャル、プレミアム</CustomContent>このアーキテクチャにより、AI 時代のワークロードに対して、弾力的なスケーラビリティ、予測可能なパフォーマンス、最適化された総所有コスト (TCO) が実現します。 | |
| TiDB Xは、クラウドネイティブのオブジェクトストレージをTiDBのバックボーンとする新しい分散SQLアーキテクチャです。現在、TiDB Cloudの<CustomContent plan="starter,essential,dedicated">StarterおよびEssential</CustomContent><CustomContent plan="premium">Starter、Essential、およびPremium</CustomContent>で利用可能です。このアーキテクチャにより、AI 時代のワークロードに対して、弾力的なスケーラビリティ、予測可能なパフォーマンス、最適化された総所有コスト (TCO) が実現します。 |
First-time contributors' checklist
What is changed, added or deleted? (Required)
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.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?