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

Abierto Apto para principiantes
#24,574 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

@yahonda ya está trabajando en esto.

Desde el 11/11/2026.

  • #24674 de @yahonda — abierto

Evaluación

Dificultad
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
88/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
aws, json

Línea de trabajo

Abre tidb-cloud/migrate-from-op-tidb.md y revisa el paso 3 de «Set up access to Amazon S3», especialmente el ejemplo de política IAM en las líneas 224–264. Mueve las descripciones de los marcadores de posición y la nota sobre SSE-KMS fuera del bloque JSON; luego corrige la coma y elimina la instrucción kms:Decrypt duplicada. El trabajo estará listo cuando el ejemplo sea JSON válido y el permiso KMS opcional esté claramente explicado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Python
Estrellas
616
Forks
724
Merge medio
2 d 5 h
PR fusionados (30 d)
168

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de pingcap/docs

Todos los issues de pingcap/docs

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.