Este repositorio agrupa la documentación en español para el proyecto AREDN®, de forma que pueda consultarse en Read the Docs
Puedes colaborar con la traducción simplemente utilizando el editor de documentos de la Web de GitHub. En la esquina superior derecha de todos los textos del repositorio, aparece un lápiz. Haciendo click ahí se nos abrirá un editor web en el que podremos modificar el archivo.
Una vez estemos contentos con nuestra edición, podemos hacer el commit desde la parte de abajo de esa misma página. Por favor, acompaña tu colaboración de una buena descripción de los cambios y/o traducciones realizados.
Si queremos añadir un poco de estilo al documento, podemos utilizar markdown para enriquecer el texto. Podrás encontrar más detalles en Markdown Cheatsheet
Para ver la documentación del proyecto en un navegador, visita https://arednmesh.readthedocs.io/en/latest/ o selecciona lo que quieras leer en el menú Docs de https://arednmesh.org
Mientras consultas la documentación de AREDN® en tu navegador, tendrás disponible un índice de contenido en el panel de navegación izquierdo. En la parte baja de ese panel lateral podrás encontrar un botón etiquetado como Read the Docs, donde se muestra la versión actual. Haz click en ese botón y tendrás la opción de descargar la documentación en cualquiera de los formatos soportados (PDF, Epub, HTML, ...)
Se trata de una opción verdaderamente útil, pues aunque no cuentes con acceso a Internet, podrás consultar la documentación al completo.
Si estás interesado en contribuir con cualquier aspecto del proyecto en auge AREDN®, puedes hacerlo fácilmente a través de GitHub. El flujo de trabajo para contribuir con la documentación es idéntico al establecido para contribuir con la creación de código. Para más información, puedes redirigirte a Cómo usar GitHub con AREDN®
La única diferencia reside en que el nombre del repositorio es aredn/documentation, mientras que el repositorio raíz se denomina master. En caso de crear una nueva branch, puedes elegir el nombre que más cómodo te resulte. Después de realizar una pull request, el equipo de AREDN® lo revisará del mismo modo que se haría con el nuevo código. Una vez que tu aportación es aplicada al repositorio maestro, una operativa en segundo plano (Webhook) procesará los cambios, haciéndolos disponibles para lectura y exportación en Read the Docs
La documentación de AREDN® está escrita y estructurada utilizando lenguaje markdown. El texto se almacena en ficheros .rst. Antes de realizar una pull request, asegurate de que tus ficheros .rst mantienen el formato y renderizan correctamente.