LinuxCommands

Estructura y referencia para documentar comandos y servicios en Linux

Objetivos del proyecto

  • Establecer un formato estándar y reutilizable para documentar comandos Linux.
  • Facilitar documentación legible, clara y mantenible.
  • Evitar duplicación y ambigüedad en la documentación técnica.
  • Servir como referencia práctica para administradores, desarrolladores y equipos técnicos.

Enfoque

LinuxCommands no sustituye herramientas como man o páginas oficiales, sino que complementa la documentación mediante:

  • Ficheros commands.md organizados por categorías.
  • Convenciones claras de documentación.
  • Ejemplos prácticos homogéneos y explicativos.
  • Organización escalable que permite crecimiento sin perder coherencia.

Estructura del repositorio

El repositorio se organiza en módulos principales:

  • .github: Configuración del proyecto, workflows de GitHub Actions, plantillas y scripts de automatización.
  • docs: Sitio web de documentación con índice, buscador y base de datos de comandos.
  • host_automation: Automatización de despliegues para servidores (Apache y Nginx) usando inventarios y plantillas.
  • host_services: Documentación de servicios de comunicación como IRC, Matrix o Mattermost.
  • host_shared_storage: Servicios de almacenamiento compartido como LDAP, NFS y Samba.
  • host_web_services: Documentación de servicios web como Apache, Nginx y WordPress.
  • local_filesystem: Comandos y teoría relacionados con el sistema de archivos.
  • local_group: Gestión de grupos de usuarios en sistemas Linux.
  • local_linux_fundamentals: Conceptos básicos de Linux y fundamentos del sistema.
  • local_miscellaneous: Herramientas y utilidades varias del sistema.
  • local_network: Comandos, teoría y configuración de redes.
  • local_permissions: Gestión de permisos, propietarios y listas de control de acceso (ACL).
  • local_process: Gestión de procesos, monitorización y tareas programadas.
  • local_scripts: Scripting en Bash, eBPF y Tcl con ejemplos y ejercicios.
  • local_security: Seguridad del sistema, auditoría, VPN, proxies y canales seguros.
  • local_services: Gestión de servicios, demonios y systemd.
  • local_software: Gestión de paquetes y software en diferentes distribuciones.
  • local_storage: Administración de almacenamiento, particiones, LVM, RAID y backups.
  • local_system_data: Información del sistema, variables de entorno, monitorización y shell.
  • local_users: Gestión de usuarios, cuentas y autenticación en Linux.

Generación de HTML / PDF

Se puede generar la documentación localmente usando asciidoctor:

# Instalar Asciidoctor
gem install asciidoctor
gem install asciidoctor-pdf

# Generar HTML
asciidoctor -b html5 document_management/index.adoc -o document_management/index.html

# Generar PDF
asciidoctor-pdf document_management/index.adoc -o document_management/LinuxCommands.pdf

Esta generación permite revisar la jerarquía y el índice centralizado antes de publicar.

Personas fisicas

Entidades fisicas recordadas por la contribución al repositorio durante los inicios del mismo.

  • ⥏﹅⥑ Andrés Ruslan Abadías – Creador
  • ⥏﹆⥑ Unai Urrestarazu Esporrín – Profesor
  • ⥏﹆⥑ Clara Cirac Nerín – Profesora
  • ⥏﹆⥑ Juan Palacios Pérez – Profesor
  • ⥏﹆⥑ Diego Gracía – Estudiante
  • ⥏﹆⥑ David Torralba – Profesor
  • ⥏﹆⥑ Jacinto Barris Vilor – Profesor