Como contribuir
Primero que nada, ¡gracias por tu motivación! 🥳
Requerimientos
Para aportar contenido directamente a la guía, debes primero tener una cuenta de GitHub
Como contribuir rápidamente en GitHub
Editar una página existente
Arriba a la derecha de cada página, encontrarás un ícono con un lápiz. Haz clic en este y edita los cambios en el archivo de Markdown.
Una vez que hayas terminado, añade un título al commit y selecciona crear un fork (o una rama).
Deberás tener la opción de crear una Pull Request (PR), que es para enviar la solucitud de cambios directamente.
¿Tienes problemas con lo anterior?
No dudes en contactarnos a traves de Instagram o Telegram si tienes una duda
Siempre puedes consultar mkdocs-material para mas detalles.
Como contribuir localmente
Antes de todo, instala Git, Python y Poetry.
Crea un fork del repositorio:
- Crea un fork del repositorio aquí
- Clona el repositorio con:
# Entra al directorio del repositorio
cd open-wiki
# Luego, instala las dependencias con:
python -m venv .venv
# Para iniciar el entorno}
# (bash, zsh)
. .venv/bin/activate
# (powershell)
.venv\Scripts\activate
# Solo 1 vez (o cuando se agregan dependencias)
python -m pip install --upgrade pip
pip install -r requirements.txt
Puedes correr el servidor de pruebas con:
Para subir los cambios, crea una rama nueva y sube los cambios con:
git switch -c <nombre-de-la-rama>
git add .
git commit -m "<mensaje>"
git push origin <nombre-de-la-rama>
Estructura y reglas
- Máximo de páginas por sección: 20
- Máximo de lineas por página: 300
- No incluir carpetas especificas sobre lenguaje especifico dentro de un curso, intenten referenciar el apartado especifico dentro de la carpeta
tec
Cambiar la configuración del sitio
La configuración del sitio vive en el archivo mkdocs.yml.
Puedes editar este archivo directamente, pero es necesario que pruebes
localmente para ver si los cambios se aplican correctamente.
Crear una nueva página
Para crear una página, sube un archivo de markdown en la carpeta docs. El path final en el URI será el path relativo desde docs.
Luego, deberás añadir el archivo a la configuración de navegación (nav)
en mkdocs.yml, añadiendo como llave el nombre de la parte y como valor el path.