Skip to content

SLEAK-5570: support scope page#222

Open
agustinoli wants to merge 2 commits into
developfrom
feat/SLEAK-5570-support-scope
Open

SLEAK-5570: support scope page#222
agustinoli wants to merge 2 commits into
developfrom
feat/SLEAK-5570-support-scope

Conversation

@agustinoli

@agustinoli agustinoli commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

Resumen

Agrega la página pública de alcance de soporte (content/docs/{en,es}/support.mdx), que documenta cómo usar el soporte de SleakOps y qué cubre el plan estándar, cross-linkeada con el modelo de responsabilidad (responsability-model.mdx).

  • Qué cubre el soporte: consultas sobre la plataforma, errores de infraestructura levantada por SleakOps, soporte en actualización de recursos.
  • Qué queda fuera del alcance estándar.
  • Tabla de responsabilidades completa (lado SleakOps / lado cliente).
  • Cómo abrir un ticket y qué esperar del flujo.

Antes de esta página no existía ninguna referencia pública de soporte/alcance en docs — el punto más cercano era responsability-model.mdx (solo backups de AWS).

Jira

SLEAK-5570

Notas

  • El cross-link a cost-review-guide (SLEAK-6054, PR SLEAK-6054: cost review tutorial #219) se agrega cuando ambas ramas estén mergeadas a develop.
  • Build de Docusaurus verificado localmente.

Summary by CodeRabbit

  • Documentación
    • Añadida la guía de Soporte en español e inglés, con información sobre cómo solicitar ayuda, problemas cubiertos y recursos recomendados.
    • Incluida una sección para aclarar responsabilidades entre SleakOps y el usuario sobre plataforma, aplicaciones, datos y copias de seguridad.
    • Actualizado el Modelo de Responsabilidad Compartida con enlaces externos más claros y una referencia directa a la documentación de soporte.

Add a client-facing Support page defining what SleakOps support
covers, with self-service pointers for common out-of-scope
questions and a short responsibility summary. Cross-link it from
the existing Shared Responsibility Model page.
@coderabbitai

coderabbitai Bot commented Jul 15, 2026

Copy link
Copy Markdown

Review Change Stack

Walkthrough

Se añaden páginas de soporte en inglés y español con información sobre cobertura, responsabilidades y recursos iniciales. Los modelos de responsabilidad actualizan el enlace de AWS y enlazan con la nueva documentación de soporte.

Changes

Documentación de soporte

Layer / File(s) Summary
Páginas de soporte bilingües
content/docs/en/support.mdx, content/docs/es/support.mdx
Se incorporan páginas de soporte con navegación, tipos de consultas cubiertas, recursos recomendados, tabla de responsabilidades y orientación para casos inciertos.
Enlaces desde los modelos de responsabilidad
content/docs/en/responsability-model.mdx, content/docs/es/responsability-model.mdx
Se ajusta el enlace al modelo de responsabilidad compartida de AWS, se añade el icono externo y se enlaza con Support.

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

Poem

Documentos que dan dirección,
soporte en cada idioma,
AWS con su enlace brillante,
responsabilidades en fila,
y conflictos resueltos a las 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 correctamente la incorporación de la página de alcance de soporte.
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 feat/SLEAK-5570-support-scope

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

🤖 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`:
- Around line 29-31: Update the “Data & backups” row in both
content/docs/en/support.mdx (lines 29-31) and content/docs/es/support.mdx (lines
29-31) so it no longer attributes backup or restoration of customer-managed
dependencies to SleakOps; align the responsibility wording with the
Responsibility Model, stating that the client manages backups for dependencies
such as RDS, S3, and RabbitMQ.
🪄 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

Run ID: 5d2c34eb-4a5b-4b30-bc37-479f24382c20

📥 Commits

Reviewing files that changed from the base of the PR and between 6d5c9b2 and b94da24.

📒 Files selected for processing (4)
  • content/docs/en/responsability-model.mdx
  • content/docs/en/support.mdx
  • content/docs/es/responsability-model.mdx
  • content/docs/es/support.mdx

Comment on lines +29 to +31
| **Platform & infrastructure** | Clusters, networking, provisioning, and the resources SleakOps creates for you | Configure environment variables, define resource requirements, and monitor usage |
| **Your application** | Provide runtime environment, CI/CD pipelines capabilities, and observability tools (logs/metrics) | Your code, its dependencies, and its performance |
| **Data & backups** | Automated execution, secure storage, and restoration capabilities. | Backup policies for your dependencies (see [Responsibility Model](/docs/responsability-model)) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== support.mdx (en) ==\n'
sed -n '1,120p' content/docs/en/support.mdx

printf '\n== support.mdx (es) ==\n'
sed -n '1,120p' content/docs/es/support.mdx

printf '\n== responsibility model references ==\n'
rg -n "backup|restore|restoration|RDS|S3|RabbitMQ|dependenc" content/docs -S

Repository: sleakops/docs

Length of output: 50370


🏁 Script executed:

#!/bin/bash
set -euo pipefail

printf '\n== responsibility model (en) ==\n'
cat -n content/docs/en/responsability-model.mdx | sed -n '1,120p'

printf '\n== backup-related mentions in support + responsibility ==\n'
rg -n "backup|restoration|restore|dependencies \(RDS, S3, RabbitMQ|don't support backups|not support backups" content/docs/en/support.mdx content/docs/en/responsability-model.mdx -S

Repository: sleakops/docs

Length of output: 1664


Ajustad la fila de “Data & backups” en ambas versiones
Ahora mismo la tabla le atribuye a SleakOps “restoration capabilities”, pero el modelo de responsabilidad dice que los backups de las dependencias (RDS, S3, RabbitMQ, etc.) los gestiona el cliente. Alinead ese texto para que no se contradigan.

📍 Affects 2 files
  • content/docs/en/support.mdx#L29-L31 (this comment)
  • content/docs/es/support.mdx#L29-L31
🤖 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` around lines 29 - 31, Update the “Data &
backups” row in both content/docs/en/support.mdx (lines 29-31) and
content/docs/es/support.mdx (lines 29-31) so it no longer attributes backup or
restoration of customer-managed dependencies to SleakOps; align the
responsibility wording with the Responsibility Model, stating that the client
manages backups for dependencies such as RDS, S3, and RabbitMQ.

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