Colaborar en la Documentación

La wiki del C-13 en la actualidad esta albergada como una pagina wiki de gitHub como parte del repositorio: https://github.com/c13inb/c13inb.github.io . Este repositorio es una pagina web hecha por Raul para el lab sin mucho uso.

Lo confuso de este esquema es que la wiki es un sub-repositorio que existe dentro de otro repositorio. Lamentablemente no tienes todas las comodidades que ofrece github para el manejo del repositorio principal (funcionalidades de pull request e interfaz grafica de commits etc) pero aun así podemos trabajar en ella colaborativamente.

Para ello primero necesitas ser colaborador del siguiente repositorio: https://github.com/c13inb/c13inb.github.io

Para esto deberás contactar al Doctor Concha y darle tu usuario de github.

Ya siendo colaborador puedes modificar la wiki con las opciones de manera web o local como se describe por aca: https://docs.github.com/en/github/building-a-strong-community/adding-or-editing-wiki-pages

La wiki esta escrita en lenguaje Markdown. Es muy simple de aprender y utilizar. Una googleada y unos 20 mins bastara. Para ver un cheatsheet de uso puedes empezar en este tutorial

Algunas reglas básicas para la organización de la Wiki:

  • Si trabajas de forma local el archivo del markdown sera el titulo de tu entrada en la wiki. Dale un nombre descriptivo. No usar \ / : * ? " < > | para que no haya conflictos en copias locales en algunos sistemas operativos cough cough windows cough cough.

  • Si quieres que tu pagina aparezca en la sidebar de la derecha necesitas modificar el archivo _Sidebar (si estas usando el repo de manera local). En la interfaz web basta con apretar en el botón editar en “Tabla de contenidos”.

  • Si tu entrada en la wiki pertenece a una subcategoría empieza su titulo con dicha categoría, posteriormente _ y luego el nombre de tu entrada. Ejemplo> Categoria_mientrada.md

  • Si ves algo que ya esta super outdated échanos la mano y dale una editada a la entrada que estas revisando. De manera local modificas el archivo (son sus subsecuente git push). En la interfaz web basta con con el botón Edit.