Skip to content

chore: add domian documentation and improvements#121

Merged
mjroson merged 1 commit intodevelopfrom
chore/SLEAK-2765-SLEAK-3692
Sep 30, 2025
Merged

chore: add domian documentation and improvements#121
mjroson merged 1 commit intodevelopfrom
chore/SLEAK-2765-SLEAK-3692

Conversation

@mjroson
Copy link
Copy Markdown
Member

@mjroson mjroson commented Sep 30, 2025

Summary by CodeRabbit

  • Documentación
    • Nuevas guías de dominios: Delegación y Niveles/Estrategias, con diagramas, tablas de propagación y troubleshooting; versiones equivalentes en español.
    • Renombrados de página y navegación: “Setup your Domains” (/domain/setup); actualización de enlaces desde Environment; cambios paralelos en es.
    • Configuración de Webservice y Alias: CNAME/ALB, SSL y verificación; checklists y decisiones rápidas.
    • Terminología de recursos actualizada a CPU/Memory Request/Limit en Cronjob, Job, Worker, Hook y Webservice; se documentan Replicas Min/Max.
    • Imágenes inline añadidas en secciones de proyecto (costes y monitoreo).
    • Enlaces internos al módulo de red actualizados a /network (también en es).

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Sep 30, 2025

Walkthrough

Se incorporan nuevas guías de dominios (estructura, delegación y configuración) en EN/ES, se actualizan enlaces internos, se añaden imágenes en páginas de proyecto y se homogeneiza la terminología de recursos (CPU/Memory Request/Limit) en workloads (EN/ES). No hay cambios de API; son actualizaciones de documentación.

Changes

Cohort / File(s) Summary of changes
Domain docs (EN)
docs/domain/delegation.mdx, docs/domain/index.mdx, docs/domain/setup.mdx
Nueva guía de delegación y estrategias de dominios; página índice con niveles/estrategias; renombre de títulos/labels y overview.
Domain docs (ES i18n)
i18n/es/.../domain/delegation.mdx, i18n/es/.../domain/index.mdx, i18n/es/.../domain/setup.mdx
Traducciones ES de la guía de delegación, índice y setup; contenido equivalente y actualización de labels.
Workload terminology update (EN)
docs/project/workload/cronjob.mdx, .../hook.mdx, .../job.mdx, .../webservice.mdx, .../worker.mdx
Sustitución de CPU/Memory Min/Max por CPU/Memory Request/Limit; en webservice se documentan Replicas Min/Max.
Workload terminology update (ES i18n)
i18n/es/.../project/workload/cronjob.mdx, .../hook.mdx, .../job.mdx, .../webservice.mdx, .../worker.mdx
Mismo cambio terminológico a Request/Limit en ES; mantienen atributos de autoscaling.
Environment cross-links
docs/environment/index.mdx, i18n/es/.../environment/index.mdx
Actualización de enlaces “delegate domains” a /domain/setup.
Project images (EN/ES)
docs/project/index.mdx, i18n/es/.../project/index.mdx
Reemplazo de placeholders por imágenes inline para botones de costos y monitoreo.
Provider accounts link (EN/ES)
docs/provider/accounts.mdx, i18n/es/.../provider/accounts.mdx
Cambio de link de Notion a ruta interna /network.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  actor U as Usuario
  participant D as Docs Sleakops
  participant R as Registrador DNS
  participant Z as DNS Padre (p.ej., Cloudflare)
  participant H as Route 53 (Hosted Zone)
  Note over D: Flujo de Delegación de Dominio (Proveedor/Entorno)
  U->>D: Consulta pasos de delegación
  U->>H: Crea/obtiene NS del dominio/zona
  alt Delegación de Proveedor (root)
    U->>R: Actualiza NS en el registrador
  else Delegación de Entorno (subdominio)
    U->>Z: Crea NS del subdominio en DNS padre
  end
  H-->>U: Propagación y verificación de NS
  Note over U,H: Loop de “Check Delegate” hasta resolver correctamente
Loading
sequenceDiagram
  autonumber
  actor U as Usuario
  participant D as Docs Sleakops
  participant WS as Webservice
  participant ALB as Endpoint/ALB
  participant ACM as Cert Manager
  Note over D: Configuración de Dominio de Webservice y Alias
  U->>D: Sigue guía de Webservice/Alias
  U->>WS: Define dominio/alias
  WS-->>ACM: Solicita/valida certificado (CNAME/DNS)
  ACM-->>WS: Cert OK
  WS-->>ALB: Publica CNAME/Target
  U->>DNS: Crea CNAME/ALIAS según caso
  ALB-->>U: Resolución y SSL funcionando
Loading

Estimated code review effort

🎯 3 (Moderado) | ⏱️ ~25 minutes

Possibly related PRs

Suggested reviewers

Poem

Nuevo mapa de dominios, trazos al compás,
NS que viajan, CNAMEs en paz.
Requests y Limits, el cluster sonríe,
botones con íconos, la guía por fin fluye.
Si hay conflictos, ya sabéis la grieta:
en Sleakops lo arreglamos a las piñas… ¡y a la carpeta correcta! 💥🗂️

Pre-merge checks and finishing touches

❌ Failed checks (3 warnings)
Check name Status Explanation Resolution
Title Check ⚠️ Warning El título “chore: add domian documentation and improvements” contiene una falta de ortografía en “domian” y resulta demasiado genérico al referirse a “improvements” sin especificar los cambios principales de dominios y otras áreas de la documentación. Por favor corrije la ortografía de “domain” y reformula el título para que refleje de manera concisa y clara el cambio principal (por ejemplo, “docs: añadir sección de dominios y corregir enlaces rotos”).
Linked Issues Check ⚠️ Warning La implementación satisface parcialmente SLEAK-2765 al crear una sección dedicada de dominios, añadir diagramas y actualizar enlaces en la página de entorno, pero no documenta el comportamiento de alias para ejecuciones ni incluye referencias en la página de servicios web; además, para SLEAK-3692 solo se corrige algún enlace roto pero no se incorporan los pasos de acceso y desinstalación de addons (VPN y otros). Añade la sección sobre alias en ejecuciones y las referencias a dominios en la página de web services, e incluye los pasos y condiciones para acceder y desinstalar addons para cumplir completamente con SLEAK-2765 y SLEAK-3692.
Out of Scope Changes Check ⚠️ Warning La PR introduce numerosos cambios de terminología en los archivos de CronJob, Hook, Job, Webservice y Worker que no guardan relación con la documentación de dominios ni con las mejoras de addons previstas en los issues vinculados, por lo que exceden el alcance definido. Separa o elimina de este PR los cambios de terminología de recursos en workloads y mantén en él únicamente las modificaciones relacionadas con la documentación de dominios y los addons.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/SLEAK-2765-SLEAK-3692

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
🧪 Early access (Sonnet 4.5): enabled

We are currently testing the Sonnet 4.5 model, which is expected to improve code review quality. However, this model may lead to increased noise levels in the review comments. Please disable the early access features if the noise level causes any inconvenience.

Note:

  • Public repositories are always opted into early access features.
  • You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 6

🧹 Nitpick comments (7)
docs/project/index.mdx (1)

93-96: Mejora aplicada correctamente, pero falta dimensionamiento.

La imagen reemplaza el placeholder de manera apropiada. Sin embargo, considerar agregar atributos width y height para evitar layout shifts durante la carga.

Aplica este diff para mejorar el rendimiento de carga:

 <img
     src="/img/project/cost-button.png"
     alt="cost-button"
+    width="120"
+    height="32"
 />

Nota: Ajusta los valores de width/height según las dimensiones reales de la imagen.

i18n/es/docusaurus-plugin-content-docs/current/project/index.mdx (1)

92-95: Cambio correcto, pero le falta el knock-out técnico.

La imagen está bien posicionada después del texto. Sin embargo, al igual que la versión en inglés, necesita dimensiones para evitar que el layout se tambalee como piña mal tirada.

Aplica este diff:

 <img
     src="/img/project/cost-button.png"
     alt="cost-button"
+    width="120"
+    height="32"
 />

Nota: Ajusta width/height según las dimensiones reales de la imagen para mantener consistencia con la versión en inglés.

docs/domain/delegation.mdx (2)

344-347: Numeración inconsistente en las opciones.

Tenés "Option 3" pero no tenés formato de lista ordenada. Además, la línea 344 dice "Option 3" cuando debería ser parte de la estructura de "Option 2" y "Option 3" propiamente. La documentación se ve desprolija.

Aplicá este diff:

-**Option 3: A Record with IP (not recommended)**
+   **Option 3: A Record with IP (not recommended)**
    - Lookup ALB IPs and create A records
    - ⚠️ IPs may change - use CNAME when possible

327-333: Falta indentación en la opción 1.

La "Option 1: CNAME" no está indentada consistentemente con las otras opciones del punto 4. Esto rompe la jerarquía visual.

Aplicá este diff:

 4. **Configure DNS at your provider**
 
-    **Option 1: CNAME (for subdomains)**
+   **Option 1: CNAME (for subdomains)**
 

</blockquote></details>
<details>
<summary>i18n/es/docusaurus-plugin-content-docs/current/domain/delegation.mdx (2)</summary><blockquote>

`345-348`: **Numeración inconsistente (versión ES).**

Mismo problema de indentación que en la versión inglesa. La "Opción 3" necesita indentación apropiada.



Aplicá este diff:

```diff
-   **Opción 3: Registro A con IP (no recomendado)**
+   **Opción 3: Registro A con IP (no recomendado)**
    - Buscar IPs del ALB y crear registros A
    - ⚠️ Las IPs pueden cambiar - usa CNAME cuando sea posible

328-334: Falta indentación en la opción 1 (versión ES).

La "Opción 1: CNAME" necesita la misma indentación que las otras opciones.

Aplicá este diff:

 4. **Configurar DNS en tu proveedor**
 
-    **Opción 1: CNAME (para subdominios)**
+   **Opción 1: CNAME (para subdominios)**
docs/domain/index.mdx (1)

431-431: Línea vacía al final del archivo.

Hay una línea vacía sobrante al final. No es crítico pero mantiene el código más limpio sin ella.

Eliminá la línea 431.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

  • Jira integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 2d63498 and c957ecc.

⛔ Files ignored due to path filters (2)
  • static/img/project/cost-button.png is excluded by !**/*.png
  • static/img/project/monitoring-button.png is excluded by !**/*.png
📒 Files selected for processing (22)
  • docs/domain/delegation.mdx (1 hunks)
  • docs/domain/index.mdx (1 hunks)
  • docs/domain/setup.mdx (1 hunks)
  • docs/environment/index.mdx (1 hunks)
  • docs/project/index.mdx (1 hunks)
  • docs/project/workload/cronjob.mdx (2 hunks)
  • docs/project/workload/hook.mdx (2 hunks)
  • docs/project/workload/job.mdx (2 hunks)
  • docs/project/workload/webservice.mdx (2 hunks)
  • docs/project/workload/worker.mdx (2 hunks)
  • docs/provider/accounts.mdx (1 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/domain/delegation.mdx (1 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/domain/index.mdx (1 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/domain/setup.mdx (1 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/environment/index.mdx (1 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/project/index.mdx (1 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/project/workload/cronjob.mdx (2 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/project/workload/hook.mdx (2 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/project/workload/job.mdx (2 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/project/workload/webservice.mdx (2 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/project/workload/worker.mdx (2 hunks)
  • i18n/es/docusaurus-plugin-content-docs/current/provider/accounts.mdx (1 hunks)
🔇 Additional comments (31)
docs/provider/accounts.mdx (1)

16-16: ¡Bien ahí! El enlace interno mejora la navegación.

El cambio de un enlace externo de Notion a una ruta interna (/network) es una mejora significativa. Facilita la navegación dentro de la documentación y reduce la dependencia de URLs externas que pueden cambiar o romperse.

i18n/es/docusaurus-plugin-content-docs/current/environment/index.mdx (1)

46-46: ¡Perfecto! La nueva estructura de dominios queda clara.

El cambio de /environment/delegate_domains a /domain/setup refleja correctamente la reorganización de la documentación de dominios en una sección dedicada, tal como se indica en los objetivos del PR.

i18n/es/docusaurus-plugin-content-docs/current/provider/accounts.mdx (1)

16-16: ¡Dale que va! Consistencia entre idiomas asegurada.

La actualización del enlace interno a /network mantiene la consistencia con la versión en inglés y mejora la experiencia de navegación para usuarios hispanohablantes.

i18n/es/docusaurus-plugin-content-docs/current/project/workload/job.mdx (2)

16-16: ¡Excelente! Terminología de Kubernetes correcta.

El cambio de "CPU Request/Limit" y "Memory Request/Limit" es la nomenclatura estándar de Kubernetes y mejora la precisión técnica de la documentación. "Request" indica recursos mínimos garantizados, mientras que "Limit" establece el máximo permitido.


58-61: ¡Consistencia impecable en toda la tabla!

Las descripciones de los atributos reflejan correctamente la nueva terminología y explican claramente la diferencia entre Request (mínimo garantizado) y Limit (máximo permitido) para CPU y memoria.

docs/project/workload/worker.mdx (2)

28-28: ¡A la cancha! Terminología estándar de Kubernetes.

La actualización a "CPU Request/Limit" y "Memory Request/Limit" alinea la documentación con la nomenclatura oficial de Kubernetes, haciendo que sea más clara para usuarios familiarizados con K8s.


67-70: ¡Todo en orden! Descripciones claras y precisas.

Las descripciones de los atributos explican correctamente el propósito de Request (recursos mínimos asignados) y Limit (recursos máximos permitidos), lo que ayuda a los usuarios a configurar adecuadamente sus Workers.

i18n/es/docusaurus-plugin-content-docs/current/domain/setup.mdx (3)

2-2: Fijate esta etiqueta: "Configura tus dominios"

El cambio de "Delegación de dominio" a "Configura tus dominios" tiene más punch y es más accionable. Bien ahí.


12-38: La explicación de los 4 escenarios está sólida

Los escenarios de delegación están bien delineados y cubren los casos principales. La estructura es clara y directa, sin vueltas innecesarias.


40-104: Las instrucciones paso a paso están completas

La guía cubre todos los flujos: dominio principal, subdominio de entorno, y alias. Las referencias a las imágenes están correctas y el flujo es lógico.

docs/project/workload/hook.mdx (2)

20-20: Terminología actualizada a Request/Limit - perfecto

El cambio de "Min/Max" a "Request/Limit" está alineado con las convenciones de Kubernetes. Esto le va a dar menos dolor de cabeza a los devs que ya conocen K8s.


72-75: Tabla de recursos actualizada correctamente

Las descripciones de CPU Request/Limit y Memory Request/Limit son claras y precisas. Todo consistente con el cambio de terminología.

i18n/es/docusaurus-plugin-content-docs/current/domain/index.mdx (4)

1-30: Nueva estructura de dominios - excelente introducción

El diagrama mermaid y la jerarquía de 4 niveles (Proveedor → Entorno → Webservice → Alias) están bien explicados. La visualización con colores diferenciados ayuda banda.


34-135: Los 4 niveles de dominio están explicados con claridad

Cada nivel (Proveedor, Entorno, Webservice, Alias) tiene:

  • Qué es
  • Ejemplos concretos
  • Lo que SleakOps crea
  • Caso de uso
  • Cuándo usarlo

La estructura es consistente y fácil de seguir. Los escenarios A y B para Alias (líneas 112-124) son especialmente útiles.


138-319: Las 3 estrategias de delegación están bien diferenciadas

  • Delegación Completa: cero configuración post-delegación, ideal para equipos chicos
  • Por Entorno: control del dominio raíz, bueno para migración gradual
  • Control Completo: máximo control, para enterprises con gobernanza estricta

Cada estrategia tiene diagramas mermaid, beneficios, y casos de uso claros. La tabla comparativa (líneas 311-318) es el cierre perfecto.


322-422: Los patrones de organización y guía de decisión son útiles

Los 3 patrones (Estándar, Mixto, Por Equipo/Proyecto) cubren casos reales. Las tablas de decisión rápida (líneas 404-422) son directas y accionables.

docs/project/workload/job.mdx (2)

18-18: Actualización de terminología en FAQ - consistente

El cambio a Request/Limit en la respuesta del FAQ mantiene la coherencia con el resto de la documentación de workloads.


60-63: Tabla de recursos actualizada - todo en orden

Las descripciones de Request/Limit para CPU y Memory están claras y alineadas con las convenciones de Kubernetes.

docs/project/workload/cronjob.mdx (2)

21-21: FAQ actualizado con la nueva terminología

Request/Limit en lugar de Min/Max. Todo alineado con los otros workloads (hook, job, worker, webservice).


75-78: Tabla de recursos completa y consistente

Las definiciones de CPU Request/Limit y Memory Request/Limit cierran el círculo de actualización terminológica en todos los tipos de workload.

i18n/es/docusaurus-plugin-content-docs/current/project/workload/hook.mdx (1)

18-18: ¡Bien ahí! Terminología actualizada correctamente.

La actualización de "CPU Min/Max" y "Memory Min/Max" a "CPU Request/Limit" y "Memory Request/Limit" alinea la documentación con la nomenclatura estándar de Kubernetes. Las traducciones al español son precisas y mantienen la claridad técnica.

Also applies to: 70-73

i18n/es/docusaurus-plugin-content-docs/current/project/workload/cronjob.mdx (1)

20-20: Cambios consistentes con la estandarización.

La actualización de terminología Request/Limit está correctamente aplicada tanto en el FAQ como en la tabla de atributos. Mantiene consistencia con los demás archivos del PR.

Also applies to: 74-77

i18n/es/docusaurus-plugin-content-docs/current/project/workload/worker.mdx (1)

27-27: Actualización precisa de terminología de recursos.

Los cambios a Request/Limit están correctamente aplicados solo para CPU y memoria, manteniendo apropiadamente la terminología Min/Max para las réplicas de autoescalado. Traducción técnica impecable.

Also applies to: 66-69

i18n/es/docusaurus-plugin-content-docs/current/project/workload/webservice.mdx (1)

50-50: Terminología estandarizada correctamente.

Las actualizaciones a CPU/Memory Request/Limit están bien aplicadas en el FAQ y la tabla de recursos. La traducción mantiene claridad y precisión técnica.

Also applies to: 207-210

docs/project/workload/webservice.mdx (1)

51-51: ¡Perfecto! Terminología alineada con estándares de Kubernetes.

La actualización de CPU/Memory Min/Max a Request/Limit en la versión en inglés está correctamente implementada. Los cambios son consistentes con las traducciones al español y mejoran la precisión técnica de la documentación.

Also applies to: 206-209

docs/domain/delegation.mdx (1)

1-467: Documentación sólida, cumple con los objetivos del PR.

La guía de delegación está completa y cubre todos los escenarios mencionados en SLEAK-2765:

  • Delegación a nivel de proveedor ✅
  • Delegación a nivel de entorno (2 escenarios) ✅
  • Configuración de webservice (automática) ✅
  • Configuración de alias (2 escenarios) ✅
  • Troubleshooting detallado ✅
  • Instrucciones específicas por registrador ✅

Los diagramas Mermaid están bien estructurados y agregan valor visual. La tabla de tiempos de propagación es útil.

i18n/es/docusaurus-plugin-content-docs/current/domain/delegation.mdx (2)

1-467: Traducción consistente y completa.

La versión en español mantiene la misma estructura y calidad que la versión en inglés. La traducción es clara y profesional.


322-324: Falta el código fence para el endpoint del ALB (versión ES).

El endpoint del ALB no está formateado como bloque de código.

Aplicá este diff:

 3. **Sleakops proporciona endpoint ALB**
 
+```
 ALB: my-alb-789012.us-east-1.elb.amazonaws.com
+```

Likely an incorrect or invalid review comment.

docs/environment/index.mdx (1)

46-46: Actualización correcta del link de delegación.

El cambio de /environment/delegate_domains a /domain/setup está bien alineado con la nueva estructura de documentación de dominios introducida en este PR.

docs/domain/setup.mdx (1)

9-12: Cambio de encabezado apropiado.

El cambio de "Delegate Domains" a "Overview" tiene sentido porque el contenido describe múltiples escenarios de delegación, no solo un proceso único. El texto introductorio ahora encuadra mejor el contenido.

docs/domain/index.mdx (1)

1-431: Documentación excelente que cumple todos los objetivos del PR.

Este archivo cumple perfectamente con los requisitos de SLEAK-2765:

  • ✅ Sección dedicada de dominios separada de la documentación de environment
  • ✅ Comportamiento de alias documentado (Escenarios A y B)
  • ✅ Diagrama explicando la estructura de dominios propuesta por SleakOps (líneas 13-31)
  • ✅ Referencias claras desde otras páginas (environment, webservice)
  • ✅ Estrategias de delegación bien explicadas con pros/contras

La tabla comparativa (líneas 312-320) y la guía de decisión rápida (líneas 408-429) son particularmente útiles para los usuarios.

Comment on lines +309 to +311

_acme-challenge.anything.com → _validation456.acme.aws.com

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Falta el código fence para el ejemplo.

El ejemplo de validación de certificado no está envuelto en un bloque de código markdown. Esto va a romper el formato visual.

Aplicá este diff:

 
-_acme-challenge.anything.com → _validation456.acme.aws.com
+```
+_acme-challenge.anything.com → _validation456.acme.aws.com
+```
 
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
_acme-challenge.anything.com → _validation456.acme.aws.com
🤖 Prompt for AI Agents
docs/domain/delegation.mdx lines 309-311: el ejemplo de validación de
certificado (_acme-challenge.anything.com → _validation456.acme.aws.com) no está
dentro de un bloque de código, lo que rompe el formato; envuelve esa línea en un
bloque de código Markdown triple backticks (``` ) — colocar la línea del ejemplo
entre una línea con ``` antes y otra con ``` después para renderizarlo
correctamente.

Comment on lines +321 to +323

ALB: my-alb-789012.us-east-1.elb.amazonaws.com

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Falta el código fence para el endpoint del ALB.

El ejemplo del ALB endpoint no está formateado como bloque de código, lo que afecta la legibilidad.

Aplicá este diff:

 3. **Sleakops provides ALB endpoint**
 
+```
 ALB: my-alb-789012.us-east-1.elb.amazonaws.com
+```
 
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
ALB: my-alb-789012.us-east-1.elb.amazonaws.com
3. **Sleakops provides ALB endpoint**
🤖 Prompt for AI Agents
In docs/domain/delegation.mdx around lines 321 to 323 the ALB endpoint line is
not formatted as a code block; wrap the endpoint line with a fenced code block
by inserting a triple-backtick line before the ALB line and a triple-backtick
line after it so the endpoint appears as a proper code fence.

Comment thread docs/domain/setup.mdx
---
sidebar_label: Delegate Domains
sidebar_position: 5
sidebar_label: Setup your Domains
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion | 🟠 Major

🧩 Analysis chain

Posible error gramatical en el label.

"Setup" como sustantivo vs "Set up" como verbo compuesto. Para un label que parece ser una acción ("configura tus dominios"), debería ser "Set up your Domains" (dos palabras).


🌐 Web query:

Is "Setup your Domains" or "Set up your Domains" grammatically correct for an action-oriented sidebar label?

💡 Result:

Use the verb form: "Set up your domains." "Set up" (two words) is the verb (action); "setup" (one word) is a noun. [1][2][3]

If you prefer a shorter label, use "Set up domains" or "Set up domain(s)". [2][3]

Sources: Merriam‑Webster (set up / setup) [1]; GrammarBook (setup vs. set up) [2]; Grammarist (set up vs. setup) [3].


Actualizar sidebar_label a Set up your Domains
Usar la forma verbal Set up (dos palabras) en lugar del sustantivo Setup.

🤖 Prompt for AI Agents
In docs/domain/setup.mdx at line 2 change the frontmatter value sidebar_label
from "Setup your Domains" to the two-word verb form "Set up your Domains";
update the string exactly to "Set up your Domains" (preserve capitalization) so
the sidebar uses the correct verb phrase.

Comment thread docs/project/index.mdx
Comment on lines +103 to +106
You can monitor your project by accessing *Projects,* selecting one **and clicking into the button: <img
src="/img/project/monitoring-button.png"
alt="monitoring-button"
/>
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Imagen inline rompe el flujo de lectura y hay un error gramatical.

Colocar una imagen en medio de una oración genera una experiencia de usuario confusa. Además, "clicking into the button" es gramaticalmente incorrecto.

Aplica este diff para corregir la estructura:

-You can monitor your project by accessing *Projects,* selecting one **and clicking into the button: <img
-    src="/img/project/monitoring-button.png"
-    alt="monitoring-button"
-/>
+You can monitor your project by accessing *Projects,* selecting one and clicking on the button:
+
+<img
+    src="/img/project/monitoring-button.png"
+    alt="monitoring-button"
+    width="120"
+    height="32"
+/>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
You can monitor your project by accessing *Projects,* selecting one **and clicking into the button: <img
src="/img/project/monitoring-button.png"
alt="monitoring-button"
/>
You can monitor your project by accessing *Projects,* selecting one and clicking on the button:
<img
src="/img/project/monitoring-button.png"
alt="monitoring-button"
width="120"
height="32"
/>
🤖 Prompt for AI Agents
In docs/project/index.mdx around lines 103 to 106, the inline image breaks
sentence flow and the phrase "clicking into the button" is incorrect; change the
sentence to read "You can monitor your project by accessing Projects, selecting
one, and clicking the button." then move the image out of the middle of the
sentence so it sits on its own block (e.g., as a separate paragraph or directly
below the sentence) with the same src and alt attributes.

Comment on lines +309 to +311
```
_acme-challenge.anything.com → _validation456.acme.aws.com
```
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Falta el código fence para el ejemplo (versión ES).

Mismo problema que en la versión en inglés. El ejemplo de validación del certificado necesita estar en un bloque de código.

Aplicá este diff:

+```
 _acme-challenge.anything.com → _validation456.acme.aws.com
+```
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```
_acme-challenge.anything.com → _validation456.acme.aws.com
```
🤖 Prompt for AI Agents
In i18n/es/docusaurus-plugin-content-docs/current/domain/delegation.mdx around
lines 309 to 311 the example line `_acme-challenge.anything.com →
_validation456.acme.aws.com` is not wrapped in a code fence; add a fenced code
block by inserting a line with ``` before the example and a line with ``` after
it so the example renders as a code block.

Comment on lines +102 to +105
Puedes monitorear tu projecto accediendo a *Projects*, seleccionando uno **y haciendo clic en el botón: <img
src="/img/project/monitoring-button.png"
alt="monitoring-button"
/>**
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Esta imagen inline necesita una revancha urgente.

Meter una imagen en medio de la oración Y envolverla en negritas (**) es como intentar resolver un merge conflict a ciegas. El usuario no va a poder leer esto sin que se le cruce el cerebro.

Aplica este diff para que no terminemos arreglando esto a las piñas después:

-Puedes monitorear tu projecto accediendo a *Projects*, seleccionando uno **y haciendo clic en el botón:  <img
-    src="/img/project/monitoring-button.png"
-    alt="monitoring-button"
-/>**
+Puedes monitorear tu projecto accediendo a *Projects*, seleccionando uno y haciendo clic en el botón:
+
+<img
+    src="/img/project/monitoring-button.png"
+    alt="monitoring-button"
+    width="120"
+    height="32"
+/>

Importante: Este cambio debe ser consistente con la corrección que se haga en la versión en inglés (docs/project/index.mdx líneas 103-106).

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
Puedes monitorear tu projecto accediendo a *Projects*, seleccionando uno **y haciendo clic en el botón: <img
src="/img/project/monitoring-button.png"
alt="monitoring-button"
/>**
Puedes monitorear tu projecto accediendo a *Projects*, seleccionando uno y haciendo clic en el botón:
<img
src="/img/project/monitoring-button.png"
alt="monitoring-button"
width="120"
height="32"
/>
🤖 Prompt for AI Agents
In i18n/es/docusaurus-plugin-content-docs/current/project/index.mdx around lines
102 to 105, the inline image is placed mid-sentence and wrapped in bold which
breaks sentence flow and readability; move the image out of the bolded sentence
and place it either immediately after the sentence or on its own line with a
brief descriptive caption or alt text, remove the bold markers surrounding the
image, and ensure the surrounding Spanish sentence punctuation and emphasis
remain correct; mirror the same structural change in the English source
docs/project/index.mdx lines 103-106 so both language versions stay consistent.

@mjroson mjroson merged commit a3d186f into develop Sep 30, 2025
1 check passed
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