tidb-cloud: the IAM policy example in migrate-from-op-tidb.md is not valid JSON
メンテナーはふだん 1 日以内に返信
評価
- 難易度
- 1/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 88/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 活発
- 技術スタック
- aws, json
- 領域
- cloud, documentation
調査の方向性
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
- 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 theStatementarray. - The comma after the
s3:ListBucketstatement is missing (it appears on its own line after the next statement instead). - The
kms:Decryptpermission for<Your AWS KMS ARN>is listed twice, in two separate statements.
- 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:Decryptstatement. - 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
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
pingcap/docs のほかの issue
-
Weekly keywords check: mismatches found対応中かも @saryn17 が 57 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
Broken Link Detectedオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
Weekly keywords check: mismatches found対応中かも @saryn17 が 57 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
Broken Link Detectedオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
メンテナーはふだん 1 日以内に返信
-
tidb-cloud: Terraform import procedures need Terraform v1.5.0 or later, but the prerequisite says >=1.0対応中かも @yahonda が 5 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 77/100
メンテナーはふだん 1 日以内に返信
似ている issue
-
area:security effort:S priority:P3 status:needs-triage type:chore
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
randomparity/kdive#3657 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 78/100
aws/mcp-proxy-for-aws#476 ·
メンテナーはふだん 1 日以内に返信
-
fix(cli): a --root that does not exist exits 0 with 'Scanned 0 file(s)', so a wrong path in CI passes silently対応中かも @arpanjot-coding が今日担当しました。 オープンarea: runtime automation bug cli code-scanning consistency developer-experience difficulty: easy github-actions good first issue help wanted json-output priority: P3 python sarif silent-failure static-analysis tests
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
-
ContainsOnly raises TypeError for unhashable input with set-based choices対応中かも @prathamchoksi が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
marshmallow-code/marshmallow#3115 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
メンテナーはふだん 1 日以内に返信