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:

  • document_management: Comandos y documentación centralizada.
  • fundamentals: Conceptos básicos y estructura del sistema.
  • networking: Configuración de red, herramientas y servicios.
  • permission_management: Control de permisos y ACLs.
  • scripting: Scripts de Bash y eBPF con ejemplos.
  • security: Seguridad, canales seguros, VPNs y proxies.
  • services: Gestión de servicios y procesos.
  • software_management: Instalación y gestión de paquetes.
  • storage: Backup, RAID, particiones y gestión de volúmenes.
  • user_permissions: Gestión de usuarios y grupos.
  • web_server: Documentación de Apache, Nginx y WordPress.

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.

Contribuciones

Las contribuciones son bienvenidas siguiendo la estructura y formato definidos (no se incluyen usuarios de GitHub):

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