feat(runme): integrar Runme como sidecar de documentación ejecutable
Agrega RUNBOOK.md y runbooks/ (fuera de content/, para no interferir con la publicación de Zola), con reglas de nombres/etiquetas/aislamiento de celdas mutantes verificadas por clusterlog validate. Instalación pinneada a v3.17.4 con checksum verificado (scripts/runme-install.sh), un job de CI separado (.gitea/workflows/ci.yml) que sólo corre celdas ci-safe, y la decisión documentada en docs/adr/0004-runme-sidecar.md y docs/RUNME.md. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
This commit is contained in:
@@ -152,6 +152,17 @@ make site # tema + estado + validación completa + sitio
|
||||
make ci # equivalente local de la canalización
|
||||
```
|
||||
|
||||
## Documentación ejecutable (Runme)
|
||||
|
||||
Los procedimientos frecuentes también existen como notebooks ejecutables,
|
||||
sin reemplazar ningún comando canónico: [`RUNBOOK.md`](RUNBOOK.md) es el
|
||||
punto de entrada. Requiere Runme `v3.17.4` (`make runme-install`) sólo si se
|
||||
quiere abrir como notebook o correr por CLI; cada celda es, además, un
|
||||
bloque de shell normal que sigue funcionando copiado a mano. Detalles,
|
||||
modelo de identidad y limitaciones conocidas en
|
||||
[`docs/RUNME.md`](docs/RUNME.md) y la decisión en
|
||||
[`docs/adr/0004-runme-sidecar.md`](docs/adr/0004-runme-sidecar.md).
|
||||
|
||||
## Estructura
|
||||
|
||||
```text
|
||||
@@ -176,6 +187,7 @@ docs/ decisiones arquitectónicas y operación
|
||||
- [`THEME_COMPATIBILITY.md`](THEME_COMPATIBILITY.md): estrategia para `zola.386`.
|
||||
- [`docs/WEEKLY_REVIEW.md`](docs/WEEKLY_REVIEW.md): guion de la reunión semanal.
|
||||
- [`docs/ADR.md`](docs/ADR.md): decisiones de diseño de **clusterlog** (la herramienta), no del clúster que administra; formato, campos y ejemplo. Registros en [`docs/adr/`](docs/adr/), sin equivalente en la UI del sitio ni en la CLI.
|
||||
- [`docs/RUNME.md`](docs/RUNME.md): documentación ejecutable con Runme — instalación, modelo de identidad y limitaciones. Punto de entrada: [`RUNBOOK.md`](RUNBOOK.md).
|
||||
- [`VALIDATION_REPORT.md`](VALIDATION_REPORT.md): pruebas ejecutadas, límites y controles pendientes.
|
||||
- [`RELEASE_NOTES.md`](RELEASE_NOTES.md): alcance de la entrega 0.1.0.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user