martin ribelotta
unread,Apr 24, 2019, 11:30:01 AM4/24/19Sign in to reply to author
Sign in to forward
You do not have permission to delete messages in this group
Either email addresses are anonymous for this group or you need the view member email addresses permission to view the original message
to Marcos Hernán García, Carlos Pantelides, Eric Pernia, ciaa-coo...@googlegroups.com, CIAA-Firmware, CIAA-Hardware
El mié., 24 abr. 2019 a las 12:25, Marcos Hernán García
(<
marcos....@gmail.com>) escribió:
>
> Buenos dias,
>
> me parecio de interes la conversacion y me sumo con una sugerencia que les puede servir. Existen varias herramientas de este estilo, pero la que conozco y se usa en muchos sitios es MkDocs. Te soluciona automaticamente todo lo que es el layout de la documentacion y se escribe todo en Markdown. Y a partir de eso te genera automaticamente todo los html y css estaticos para subirlo donde quieras. Inclusive hay formas sencillas de subirlos a las wikis de GitHub, Gitlab, etc.
>
>
https://www.mkdocs.org/
>
> Lo tiro por si no lo conocian y capaz le soluciona bastante de las problematicas en lo que respecta a la documentacion. Es muy facil de usar. Lo bueno es que si lo quieren versionar solo necesitan versionar los Markdown. Y no el resto de la basura.
>
Mkdocs esta genial, y Eric lo estuvo usando para varias cosas. Es una
de las opciones que manejamos para el tema de la pagina tecnica (que
derive en la wiki o algo así)
Ahora... teniendo la wiki? hace falta la pagina de github? Teniendo la
pagina de github hace falta la wiki? La ventaja de la wiki en github
es que es fácil editarlo online y no necesita generación de HTML
estático... la desventaja es que te da menos flexibilidad para armar
un aspecto visual (es necesario eso?)
Las wikis de que proporciona gitlab/github son básicamente un repo al
que se puede acceder con commit/pull/push/pull-request asi que
tendríamos todas las ventajas de usar una pagina de proyecto y ninguna
de las desventajas de tener que generar código html cada vez que se
commitea (cosa que se puede automatizar, no lo niego... pero hay que
hacerlo jejejeje)
Que opinan?