LinuxCommands nació como una recopilación de apuntes personales para organizar y entender mejor distintos comandos, scripts y servicios en Linux.
Con el tiempo, se fue estructurando para que sea más fácil de navegar y consultar, tanto para mí como para cualquier persona interesada en aprender o consultar comandos y servicios de manera práctica.
- Proporcionar un formato claro y reutilizable para documentar comandos Linux.
- Facilitar una documentación legible para humanos y mantenible a largo plazo.
- Reducir duplicación, ambigüedad y variaciones innecesarias entre repositorios.
- Servir como referencia práctica para administradores de sistemas, desarrolladores y equipos técnicos.
El repositorio no pretende sustituir herramientas existentes como man, sino complementarlas mediante:
- Ficheros
commands.mdestructurados, - Convenciones claras de documentación,
- Ejemplos prácticos y homogéneos,
- Una organización pensada para crecer sin perder consistencia.
El formato utilizado está definido formalmente en un documento de origen y se aplica de forma uniforme en todo el repositorio.
El repositorio tiene su origen en el fichero Documento de Origen, al que posteriormente siguió una versión con una estructura más elaborada, denominado Modelo Base.
Con el crecimiento progresivo de la documentación, este enfoque resultó poco manejable debido al volumen de información concentrada en un único fichero, por lo que fue finalmente descartado.
Como solución, se adoptó un modelo estructurado y escalable de documentación, que dio lugar al uso de un índice centralizado, dando lugar al fichero index.adoc, de donde se comenzó la primera generación de PDFs
Instrucciones rápidas para generar la documentación localmente y comprobar la jerarquía y el índice.
Prerequisitos:
asciidoctorpara HTML.asciidoctor-pdfpara generar PDF directamente (opcional).
Instalación (si dispone de Ruby/gems):
gem install asciidoctor
gem install asciidoctor-pdfGenerar HTML:
asciidoctor -b html5 document_management/index.adoc -o document_management/index.htmlGenerar PDF (directo con asciidoctor-pdf):
asciidoctor-pdf document_management/index.adoc -o document_management/LinuxCommands.pdfLa organización del repositorio está pensada para facilitar la navegación y el crecimiento progresivo del contenido:
- document_management
- fundamentals
- networking
- permission_management
- process_tasks
- scripting
- security
- services
- software_management
- storage
- system_data
- user_permissions
- web_server
Las contribuciones son bienvenidas siempre que respeten el formato y la estructura definidos.
El objetivo es mantener una documentación coherente y de alta calidad.
