Este repositorio es para crear la documentación para el proyecto AREDN, de forma que pueda hacerse disponible en ReadTheDocs.
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 hacel el 'commit' desde la parte de abajo de esa misma página. Porvavor, acompaña tu colaboración de una buena descripción de lo que has hecho.
Si queremos añadir un poco de estilo al documento, podemos utilizar markdown para enrriquecer el texto. Más detalles en: https://github.com/adam-p/markdown-here/wiki/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.
While viewing the AREDN documentation in your web browser, you will see the contents list in the left panel. At the bottom of the panel is a drawer labeled "ReadTheDocs" showing the version you are viewing. Click the label bar to open it. From the drawer you can export the documentation set as a single PDF or Epub file. This is handy if you want to take a PDF copy of the guidebook with you into the field where you do not have Internet access.
If you are interested in contributing to the rapidly growing set of AREDN related information, you can easily do so on GitHub. The workflow for contributing documentation is identical to the workflow for contributing code which is described in detail here: How to Use GitHub for AREDN.
The only difference is the repository name of aredn/documentation and the main branch name of master. Your local code branch name can be anything that makes sense to you. After you create your Pull Request, the AREDN team will review your request just as it does for code changes. Once your documentation contributions are committed to the AREDN GitHub repository, a webhook updates and builds the latest docs for viewing and exporting on ReadTheDocs.org
AREDN documentation is written using the reStructuredText markup language. Text is saved in "rst" files. Before committing your changes, be sure to test your rst files to ensure they will render correctly.