tidb-cloud: the IAM policy example in migrate-from-op-tidb.md is not valid JSON

オープン 初心者向け
#24,574 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@yahonda がすでに取り組んでいます。

2026年11月11日 から。

  • #24674 @yahonda による — オープン

評価

難易度
1/5
見積もり時間
1〜3時間
初心者へのやさしさ
88/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
aws, json

調査の方向性

tidb-cloud/migrate-from-op-tidb.mdを開き、「Set up access to Amazon S3」の手順3、特に224~264行目のIAMポリシーの例を確認してください。プレースホルダーの説明とSSE-KMSに関する注記をJSONブロックの外に移し、カンマを修正して、重複しているkms:Decryptステートメントを削除してください。例が有効なJSONになり、オプションのKMS権限が明確に説明されていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Error Report

  1. What is the URL/path of the document related to this issue?

tidb-cloud/migrate-from-op-tidb.md, step 3 of "Set up access to Amazon S3" (the IAM policy example at lines 224-264 on master and release-8.5).

Step 3 tells users to create the policy on the JSON tab of the IAM console, and the following code block is labeled json. However, the example is not valid JSON, so the JSON editor rejects it if users paste it as is:

  • The block starts with four ## comment lines (the template title and the descriptions of <Your customized directory>, <Your S3 bucket ARN>, and <Your AWS KMS ARN>).
  • A // comment line appears inside the Statement array.
  • The comma after the s3:ListBucket statement is missing (it appears on its own line after the next statement instead).
  • The kms:Decrypt permission for <Your AWS KMS ARN> is listed twice, in two separate statements.
  1. How would you like to improve it?
  • Move the ## placeholder descriptions and the SSE-KMS note out of the code block, as plain text before it.
  • Make the code block valid JSON: fix the comma placement and keep only one kms:Decrypt statement.
  • Optionally, show the KMS statement as a separate snippet (or describe it in text) because it is needed only when SSE-KMS is enabled for the bucket.

The Japanese translation keeps the code block byte for byte from the English, so it will follow the English fix through the weekly sync. This was found by CodeRabbit on the Japanese PR #24566.

🤖 Generated with Claude Code

主要言語
Python
スター
616
フォーク
724
平均マージ
2日 5時間
マージ済み PR(30日)
168

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

pingcap/docs のほかの issue

pingcap/docs の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。