Documentación tipo libro

Saludos! Agradezco mucho este foro, y la rapidez y detalle de las respuestas :slight_smile: .

Ahora estamos a más de un año después de lanzar el foro, y ahora hay decenas de guías en tres idiomas, y LibreRouterOS ya está en v1.4.2… y me pregunto: sería más fácil mantener esta información en formato de documentación más convencional, como las docs de Ansible? Así podrían revisar la documentación con cada release, actualizar cualquier cosa, y así estar seguros que la documentación esté al día. Además los lectores pueden ver la documentación para su versión de LibreRouterOS, y quizás mirar los docs para un release nuevo y analizarlo antes de instalar.

Hola Pato!

La documentación convencional esta aquí Documentación | y el foro hace las veces de ir creando de a poco colectivamente recursos, discusiones y documentación adicional. El problema con las formas convencionales de documentación es que no son muy simples para que la comunidad participe manteniendolas Por otro lado es un trabajo grande mantener todo actualizado…

Hola @SAn , de acuerdo que la participación es muy importante, y que mantener toda la documentación es un trabajo significativo. La documentación que indicas está presentada de una manera que me parece muy buena para personas que no van a meterse en las entrañas de lime-config, y sin duda ese es el público principal para el LibreRouter. Esa documentación cumple bien su función.

Para las personas que queremos salir del camino principal, el foro sí nos sirve. Donde veo un cambio posible es en las páginas que son tipo wiki en este foro y que tienen instrucciones detalladas con comandos que son diferentes en las distintas versiones de LROS.

Voy a llamar lo que está hecho “documentación exterior” porque es para los momentos cuando no quiero mirar a las entrañas del LR. Voy a llamar esta documentación que imagino “documentación interna” porque pertenece a las funciones internas de LROS. Podríamos pensar otros nombres, por ejemplo como Decko que tiene Shark Docs y Monkey Docs que son para diferentes funciones.

Yo imagino al trabajo de programar como, “ahora mi pull request fue integrado a la rama, ahora voy a modificar lo que corresponde en la documentación interna.” Pero eso deja lugar al olvido. Entonces para simplificar, podría haber unos archivos en formato Markdown en el mismo repo que el código, en una carpeta /docs-md, con un archivo para lo que es ahora cada página wiki en este foro. Entonces cuando modifico el código, también modifico la documentación, y va todo junto en un solo pull request. En los archivos de docs-md, quedan secciones para cada versión de LROS, y una sección “desarrollo” o algo así dónde van las modificaciones que aún no son parte de un release.

Espero que algo así sería útil también para el equipo de desarrollo, además que la gente que modifican sus LR más allá del camino principal.