Propuesta de automatización para un proceso de producción de baldosas cerámicas desarrollado por estudiantes de la Universidad Nacional de Colombia.
- Andres Sebastian Serna Montano
- Valentina Hernandez Montes
- Juan Sebastian Dueñas Salamanca
- Julian Felipe Luna Castro
La documentación del proyecto fue creada usando vitepress. una libreria de Vue utilizando node js y sistema de empaque yarn
. Puedes seguir la siguiente guía de como comenzar a usar vitepress
Tener instalado node js y yarn
Para instalar la libreria de vitepress
yarn add -D vitepress
Para hacer un despliegue local para prueba de resultados
yarn run docs:dev
Para hacer un despliegue automatico de la pagina web en github pages se configuró un archivo de github actions en la carpeta .github/workflows/deploy.yml donde se construye el sitio web. Este es activado por commits a la rama main o ramas que comiencen por docs/*
.
Es fácil cometer errores que al momento de hacer un commit, para evitar esto se puede configurar un hook de pre-commit que ejecute un comando antes de hacer el commit. En este caso se ejecuta el comando yarn docs:build
para verificar que la documentación se construye correctamente. Si se produce un error no se realiza el commit. En la experiencia del equipo se observo que un error común era generar links rotos. Esto chequeo previo previene subir este tipo de errores.
echo 'yarn docs:build' > .git/hooks/pre-commit