Documentación
Qué está documentado y qué todavía no
Hoy no hay un portal público de documentación. La documentación existe —unas 200 páginas— pero vive en un repositorio privado, se entrega con tu instalación y todavía no tiene un sitio público renderizado y versionado. En lugar de enlazarte a un portal que no existe, este es el estado honesto de cada parte.
| Elemento | Estado | Qué significa hoy |
|---|---|---|
| Runbooks de despliegue y operaciones | disponible | Escritos y completos. Se entregan con tu instalación; no están en un sitio público. |
| Referencia de arquitectura | disponible | Escrita. Algunos internos de ejecución siguen sin documentar. |
| Limitaciones del producto y carencias conocidas | disponible | Escritas sin adornos. La mejor fuente única de lo que aún no funciona. |
| Referencia de la API HTTP | disponible | La referencia se genera a partir del documento OpenAPI del hub en cada versión y lleva la versión del hub. |
| Runbooks de instalación y actualización aislada | opcional | Escritos, y solo relevantes si eliges el despliegue aislado. Hoy están dirigidos a ingenieros de release, no a tus operadores. |
| Guía de instalación autoalojada para clientes | planificado | No escrita. El utillaje de instalación funciona y está probado; la guía que un ingeniero externo a Caldyr pudiera seguir todavía no existe. |
| Portal público de documentación renderizado y versionado | planificado | No construido. Sin generador, sin paso de build, sin dominio. Esta página es el marcador hasta que exista. |
| Documentación en ruso, español, estonio y finés | en curso | Existen páginas traducidas, pero van por detrás del inglés y no se han revisado desde su consolidación. |
| Registros de decisiones de arquitectura | planificado | No existe ninguno. Las decisiones se recuperan del historial de commits, que no es lo mismo. |
| Whitepaper de seguridad versionado | planificado | No escrito. La página de seguridad es un resumen, no un whitepaper, y así está etiquetada a propósito: no hay documento fechado y versionado que descargar. |
| Referencia de API generada desde un esquema legible por máquina | disponible | Construida. El hub sirve su documento OpenAPI en /api/openapi.json con la versión del hub, y la página de referencia se genera a partir de él en cada versión. |
| Guía de despliegue en Kubernetes y Helm | investigación | En estudio. Hoy no hay chart ni manifiestos; la forma soportada es Docker Compose en un host. |
- Referencia de la API en el hub (requiere iniciar sesión)
- Documento OpenAPI (público, JSON)
- Documentación de usuario dentro de la aplicación, en el hub (requiere iniciar sesión)
Si necesitas alguno de los puntos no escritos para evaluar Caldyr, pídelo y te enviaremos lo que exista en lugar de decirte que está publicado.