Skip to content

docs: support-scope review adjustments + KMS step in RDS snapshot restore - #231

Open
agustinoli wants to merge 3 commits into
developfrom
docs/support-scope-review-fixes
Open

docs: support-scope review adjustments + KMS step in RDS snapshot restore#231
agustinoli wants to merge 3 commits into
developfrom
docs/support-scope-review-fixes

Conversation

@agustinoli

@agustinoli agustinoli commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Ajustes acordados en la reunión de revisión de la página de soporte, más un paso faltante en el tutorial de migración de snapshots de RDS. Todo en EN y ES.

Página de soporte (content/docs/{en,es}/support.mdx)

Sección "Dónde mirar primero":

  • El bullet de "algo falla en tu aplicación" ahora muestra que existe el Autodiagnóstico con IA como primer paso.
  • El bullet de "la aplicación se siente lenta" lleva a Grafana (antes Kubecost + Prometheus).
  • El bullet de Dockerfile/build lleva a Configure your Dockerfile (antes apuntaba mal a Chart Dependencies).
  • El bullet de gasto en AWS suma el link al tutorial Cost Review Guide además de las estrategias de optimización.

Tabla "Responsabilidad de un vistazo":

  • Fila "Plataforma e infraestructura": se explicita la excepción — SleakOps responde por los recursos que crea siempre que no se modifiquen directamente en AWS por fuera de la plataforma.
  • Fila "Datos y backups": "su almacenamiento seguro" pasa de la columna de SleakOps a la del cliente, junto a las políticas de backup y restauración.

Tutorial migrate-rds-snapshot-between-accounts (content/tutorials/{en,es}/)

  • Caso 3 (CMK), bloque de restore: nuevo paso para seleccionar la clave en el campo KMS Key ID del form "Create an RDS from a snapshot" cuando la snapshot no está cifrada con la clave predeterminada de AWS. Verificado contra el schema real de la dependencia RDS (campo kmsKeyId: "If not specified, the default AWS-managed key is used").

Build de Docusaurus verificado en ambos idiomas.

Summary by CodeRabbit

  • Documentación

    • Actualizada la guía de “Responsabilidad de un vistazo” con nuevas referencias para rendimiento (Grafana), Docker/build y una “Guía de revisión de costos”.
    • Ajustada la tabla comparativa “SleakOps vs. Tú” con condiciones claras sobre gestión de infraestructura y un reparto más preciso de “Datos y backups”.
  • Tutoriales

    • Corregido el procedimiento de restauración de snapshots RDS cifradas entre cuentas con clave KMS personalizada (CMK), incluyendo el orden de los pasos.
    • Añadido el paso para seleccionar la clave KMS adecuada antes de introducir el identificador del snapshot copiado.

…tore

Support page (EN/ES):
- "Something's wrong in your application" now points to the AI-powered
  Autodiagnostic as a first step.
- "The application feels slow" links to Grafana instead of
  Kubecost/Prometheus.
- Dockerfile/build questions link to "Configure your Dockerfile"
  instead of Chart Dependencies.
- AWS spend bullet also links to the Cost Review Guide tutorial.
- Responsibility table: SleakOps covers the resources it creates as
  long as they aren't modified directly in AWS; secure storage of data
  moves to the client side, next to backup/restoration policies.

RDS snapshot migration tutorial (EN/ES):
- Case 3 restore: new step to select the KMS key in the "Create an RDS
  from a snapshot" form when the snapshot isn't encrypted with the
  default AWS-managed key.
@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 189b847d-b0d6-4ad3-8c28-12d1cb77ace1

📥 Commits

Reviewing files that changed from the base of the PR and between 8013302 and 55f8b84.

📒 Files selected for processing (4)
  • content/docs/en/support.mdx
  • content/docs/es/support.mdx
  • content/tutorials/en/migrate-rds-snapshot-between-accounts.mdx
  • content/tutorials/es/migrate-rds-snapshot-between-accounts.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
  • content/tutorials/en/migrate-rds-snapshot-between-accounts.mdx
  • content/tutorials/es/migrate-rds-snapshot-between-accounts.mdx
  • content/docs/en/support.mdx

Walkthrough

Se actualizan las páginas bilingües de responsabilidades y el procedimiento bilingüe para restaurar snapshots RDS cifradas con una clave KMS personalizada.

Changes

Responsabilidades de soporte

Layer / File(s) Summary
Guías y reparto de responsabilidades
content/docs/en/support.mdx, content/docs/es/support.mdx
Se actualizan las referencias a Grafana, Docker/build y costes de AWS, y se precisa el reparto sobre infraestructura, aplicaciones, datos y backups.

Restauración de snapshots RDS

Layer / File(s) Summary
Paso de restauración con KMS
content/tutorials/en/migrate-rds-snapshot-between-accounts.mdx, content/tutorials/es/migrate-rds-snapshot-between-accounts.mdx
El flujo añade la selección del KMS Key ID y desplaza la introducción del identificador de la snapshot al paso siguiente.

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

Possibly related PRs

  • sleakops/docs#181: Comparte el tutorial de migración de snapshots RDS cifradas.
  • sleakops/docs#219: Añade la guía de revisión de costes enlazada desde support.mdx.
  • sleakops/docs#222: Modifica las páginas y la tabla de responsabilidades actualizadas.

Poem

Grafana vigila, KMS da la llave,
la snapshot cruza sin que nada falle.
Docker se ordena, el coste se aclara,
y los conflictos se arreglan a piñas.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed El título resume bien los dos cambios principales: ajustes en la documentación de soporte y el paso KMS del tutorial RDS.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/support-scope-review-fixes

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

🧹 Nitpick comments (1)
content/docs/en/support.mdx (1)

32-32: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick win

Corrige la redacción de la capacidad de CI/CD.

CI/CD pipelines capabilities suena antinatural y deja ambiguo el alcance de la responsabilidad. Usad CI/CD pipeline capabilities o CI/CD pipelines para mantener la tabla clara y alineada con la versión española.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@content/docs/en/support.mdx` at line 32, Update the “Your application” row in
the support responsibility table to replace “CI/CD pipelines capabilities” with
the natural “CI/CD pipeline capabilities” wording, leaving the surrounding
responsibility descriptions unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@content/docs/en/support.mdx`:
- Line 33: Update the “Data & backups” row in content/docs/en/support.mdx lines
33-33 to state that users configure and manage dependency backup and restoration
policies in AWS, removing any suggestion that SleakOps provides automated RDS
backups. Apply the same clarification in Spanish in content/docs/es/support.mdx
lines 33-33, explicitly avoiding attribution of RDS backup provision to
SleakOps.

In `@content/docs/es/support.mdx`:
- Line 25: Actualiza el enlace de AWS en el contenido de soporte en español para
que apunte a https://docs.aws.amazon.com, alineándolo con la versión inglesa y
manteniendo intacto el resto del texto.

---

Nitpick comments:
In `@content/docs/en/support.mdx`:
- Line 32: Update the “Your application” row in the support responsibility table
to replace “CI/CD pipelines capabilities” with the natural “CI/CD pipeline
capabilities” wording, leaving the surrounding responsibility descriptions
unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 49030514-7f6f-4695-962f-4b82598f9a5d

📥 Commits

Reviewing files that changed from the base of the PR and between 67ae817 and 8013302.

📒 Files selected for processing (4)
  • content/docs/en/support.mdx
  • content/docs/es/support.mdx
  • content/tutorials/en/migrate-rds-snapshot-between-accounts.mdx
  • content/tutorials/es/migrate-rds-snapshot-between-accounts.mdx

Comment thread content/docs/en/support.mdx Outdated
Comment thread content/docs/es/support.mdx Outdated
The RDS dependency schema validates kmsKeyId against a full-ARN
pattern, so the restore step now says to enter the key's full ARN
instead of "selecting" it.
- "Data & backups" SleakOps cell now says the platform exposes the
  resource's backup settings in the dependency form (RDS "Automated
  Backup" toggle, retention period) instead of "provides backup
  options", removing the reading that SleakOps runs the backups.
- ES: AWS documentation link points to docs.aws.amazon.com like the
  English version, instead of the aws.amazon.com homepage.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant