diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 4c52346..b1ac0dc 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -18,5 +18,5 @@ jobs: key: ${{ github.ref }} path: .cache - run: cd mkdocs - - run: pip -r requirements.txt + - run: pip install -r requirements.txt - run: mkdocs gh-deploy --force diff --git a/mkdocs/docs/howto/ComoColaborar.md b/mkdocs/docs/howto/ComoColaborar.md index 1847172..6c3ee78 100644 --- a/mkdocs/docs/howto/ComoColaborar.md +++ b/mkdocs/docs/howto/ComoColaborar.md @@ -1,12 +1,12 @@ -# How to contribute to this documentation +# Cómo contribuir a esta documentación -> The main documentation of the SCOOP project. +> La documentación principal del Libre DataCenter. -Deployed at https://carbon-offset-open-platform.github.io/mainPublicDoc. +Desplegado en https://jaquerespeis.github.io/libreDataCenter/ -## Contribute +## Contribuir -### Setting up +### Configurar ambiente ``` git clone git@github.com:Carbon-Offset-Open-Platform/mainPublicDoc.git python3 -m venv venv @@ -14,21 +14,21 @@ source venv/bin/activate (venv) ~ pip install mkdocs-material ``` -### Add content -1. Create a `.md` file in the respective folder and write your content in Markdown formatting. [Learn more here.](https://www.markdownguide.org/). -1. Edit `mkdocs.yml` and add your file to the `nav` section. -1. Commit and sync your GIT repo. +### Añadir contenido +1. Crea un archivo `.md` en la carpeta respectiva y escribe tu contenido utilizando formato Markdown. [Aprende más aquí.](https://www.markdownguide.org/). +1. Edita `mkdocs.yml` y agrega tu archivo a la sección `nav`. +1. Realiza un commit y sincroniza tu repositorio GIT. -### Test and Build +### Probar y construir -After getting into the Python environment either run serve to see the results locally in your web browser: +Después de ingresar al entorno de Python, puedes ejecutar `serve` para ver los resultados localmente en tu navegador web: ``` source venv/bin/activate (venv) ~ pip install mkdocs-material mkdocs serve ``` -Or when everything is done, run build to create the static website: +O, cuando todo esté listo, ejecuta `build` para crear el sitio web estático: ``` mkdoc build ``` diff --git a/mkdocs/mkdocs.yml b/mkdocs/mkdocs.yml index 259df67..0c5bf2f 100644 --- a/mkdocs/mkdocs.yml +++ b/mkdocs/mkdocs.yml @@ -35,9 +35,9 @@ theme: nav: - Home: 'index.md' - Pasos: - - Lista de materiales: 'docs/pasos/ListaDeMateriales.md' + - Lista de materiales: 'pasos/ListaDeMateriales.md' - HowTos: - - Colaborar: 'docs/howto/ComoColaborar.md' + - Colaborar: 'howto/ComoColaborar.md' markdown_extensions: - def_list