Sistema de control de versiones del proyecto de documentación de Debian

El proyecto de documentación de Debian almacena sus páginas web y gran parte del texto de los manuales en el servicio Salsa de Debian en salsa.debian.org, que es la instancia GitLab de Debian. Puede consultar la documentación de Salsa para más información sobre el funcionamiento de este servicio.

Cualquiera puede descargar los fuentes desde el servicio Salsa. Solo los miembros del proyecto de documentación de Debian pueden actualizarlos.

Acceso a los fuentes en git

Puede utilizar una interfaz web para acceder a los ficheros individualmente y ver las modificaciones hechas a cada proyecto en https://salsa.debian.org/ddp-team/.

Para descargar un manual completo, el acceso directo al servidor git suele ser una opción mejor. Necesita el paquete git en su propia máquina.

Clonado de un repositorio git de forma anónima (sólo-lectura)

Use esta orden para descargar todos los ficheros de un proyecto:

git clone https://salsa.debian.org/ddp-team/release-notes.git

Haga lo mismo para cada proyecto que quiera clonar.

Clonado de un repositorio git con privilegios de actualización (lectura-escritura)

Antes de acceder al servidor git por este método le han tenido que conceder acceso de escritura. Por favor, lea antes cómo solicitar permiso de actualización.

Use esta orden para descargar todos los ficheros de un proyecto:

git clone git@salsa.debian.org:ddp-team/release-notes.git

Haga lo mismo para cada proyecto que quiera clonar.

Descarga de modificaciones desde el repositorio git remoto

Para actualizar su copia local con los cambios hechos por otros, entre en el directorio manuals y ejecute la orden:

git pull

Obtención de privilegios de actualización (de «push»)

Cualquiera que desee participar en la escritura de manuales puede obtener privilegios de actualización (de «push»). Generalmente, solo pedimos que quien los solicita haya enviado previamente un par de parches útiles.

Una vez creada su cuenta en Salsa, solicite privilegios de actualización («push») pulsando en Request to join («solicitud de ingreso») en el grupo o en cualquiera de los proyectos específicos bajo https://salsa.debian.org/ddp-team/. A continuación, envíe un correo electrónico a debian-doc@lists.debian.org exponiendo el historial de su trabajo en Debian.

Una vez que su solicitud sea aprobada, formará parte, bien del grupo ddp-team, o de uno de sus proyectos.


Mecanismo de actualización automática

Las páginas web que contienen el texto de los manuales se generan en www-master.debian.org como parte del proceso ordinario de generación del sitio web, proceso que tiene lugar cada cuatro horas.

El «script» ejecuta la orden svn export --force svn://svn.debian.org/svn/ddp/manuals y, a continuación, make -C trunk publish.

El «makefile» está configurado para generar cada subdirectorio (que contenga documentación en desarrollo), y para instalar los ficheros de cada subdirectorio existente bajo el directorio doc/manuals/ del sitio web. Los «makefiles» de los subdirectorios se derivan del manuals/standard.makefile.

Los ficheros de documentación generados por el «script» de actualización se encuentran en https://www.debian.org/doc/manuals/.

Los ficheros de «log» generados por el «script» de actualización se encuentran en https://www-master.debian.org/build-logs/ddp/.

Tenga en cuenta que este proceso genera de nuevo el directorio /doc/manuals/. El contenido del directorio /doc/ se genera, bien a partir de «webwml», bien con otros «scripts», como los que extraen ciertos manuales de sus paquetes.