Cloudeval

Documentación de Cloudeval

Documentación para Cloudeval construida con MkDocs y el tema Material.

Configuración

1. Instalar dependencias:

   pip install -r requirements.txt
   

2. Servir la documentación localmente:

   mkdocs serve
   

   Visita http://127.0.0.1:8000 para ver el sitio.

3. Construir la documentación:

   mkdocs build
   

Estructura

• docs/ - Archivos fuente de la documentación
• mkdocs.yml - Configuración de MkDocs
• requirements.txt - Dependencias de Python
• .github/workflows/docs.yaml - Flujo de trabajo de GitHub Actions para el despliegue

Despliegue

La documentación se despliega automáticamente en GitHub Pages usando GitHub Actions:

1. Despliegue automático: En cada push a la rama main
2. Despliegue manual: Usa el despacho de flujos de trabajo en GitHub Actions
3. Proceso de despliegue:
   • Construye el sitio de MkDocs
   • Realiza push a la rama gh-pages
   • Despliega mediante GitHub Pages Actions

Configuración inicial

Antes del primer despliegue:

1. Habilita GitHub Pages en Configuración del repositorio → Pages (Fuente: GitHub Actions)
2. Crea la rama gh-pages (consulta DEPLOYMENT.md)
3. Haz push del archivo de flujo de trabajo para activar el despliegue

URL del sitio

Una vez desplegado, el sitio estará disponible en:

• Dominio personalizado: https://docs.cloudeval.ai/ (después de la configuración de DNS)
• GitHub Pages: https://ganakailabs.github.io/cloudeval/

Dominio personalizado

Este repositorio está configurado para usar el dominio personalizado docs.cloudeval.ai.

Para la configuración de DNS de Namecheap, consulta NAMECHEAP_DNS_SETUP.md para instrucciones paso a paso.

Para información general sobre dominios personalizados, consulta docs/CUSTOM_DOMAIN.md.

Documentación

• Guía de despliegue - Información detallada sobre el despliegue
• Configuración de dominio personalizado - Cómo configurar un dominio personalizado