Le dépôt VCS du projet de documentation Debian

Les pages web et la plupart des manuels du Projet de documentation Debian sont disponibles sur le serveur Salsa de Debian à l'adresse salsa.debian.org qui est l’instance GitLab de Debian. Veuillez lire la documentation sur Salsa pour davantage d’informations sur le fonctionnement de ce service.

Tout le monde peut télécharger les sources à partir du service Salsa. Seuls les membres du projet de documentation Debian peuvent les mettre à jour.

Accéder aux sources sur le dépôt Git

Vous pouvez utiliser l'interface web pour accéder aux différents fichiers et voir les modifications dans chaque projet sur https://salsa.debian.org/ddp-team/.

Pour télécharger un manuel complet, un accès direct au serveur Git est souvent la meilleure solution. Vous aurez besoin du paquet git sur votre propre machine.

Se connecter anonymement (mode lecture seule) sur le serveur Git

Utilisez cette commande pour télécharger tous les fichiers d’un seul projet :

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

Faites de même pour chaque projet que vous voulez cloner localement.

Cloner un dépôt Git avec les privilèges de mise à jour (mode lecture et écriture)

Avant d’accéder au serveur Git en utilisant cette méthode, les droits d’écriture doivent d’abord vous être accordés. Veuillez lire en premier comment solliciter la permission de mise à jour.

Utilisez cette commande pour télécharger tous les fichiers d’un projet particulier :

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

Faites de même pour chaque projet que vous voulez cloner localement.

Récupérer les modifications du dépôt distant de Git

Pour actualiser votre copie locale avec les modifications effectuées par d'autres personnes, entrez dans le répertoire manuals et lancez la commande :

git pull

Obtenir les privilèges de mise à jour

Les privilèges de mise à jour (push) sont accordés à tous ceux désirant participer à l’écriture des manuels. Nous demandons habituellement que vous ayez d’abord présenté quelques correctifs utiles.

Après la création de votre compte pour Salsa, demandez les privilèges de mise à jour en cliquant sur Request to join pour le groupe ou n’importe quel projet particulier dans https://salsa.debian.org/ddp-team/. Veuillez ensuite envoyer un courriel à debian-doc@lists.debian.org expliquant les antécédents de votre travail dans Debian.

Une fois votre requête acceptée, vous serez membre du groupe ddp-team ou d’un de ses projets.


Mécanisme de mise à jour automatique

Les pages web publiées de texte de manuel sont générées sur www-master.debian.org dans le cadre du processus de reconstruction qui se déroule toutes les quatre heures.

Le script exécute un svn export --force svn://svn.debian.org/svn/ddp/manuals, et puis make -C trunk publish.

Le makefile est réglé pour reconstruire chaque sous-répertoire (qui contient la documentation à jour) et pour installer les fichiers de chaque sous-répertoire dans le sous-répertoire doc/manuals/ du site web. Les makefile des sous-répertoires sont dérivés de manuals/standard.makefile.

Les fichiers de la documentation générés par le script de mise à jour peuvent être trouvés sur https://www.debian.org/doc/manuals/.

Les fichiers de journaux générés par le script de mise à jour peuvent être trouvés sur https://www-master.debian.org/build-logs/ddp/.

Notez que ce processus régénère le répertoire /doc/manuals/. Le contenu du répertoire /doc/ est généré soit depuis webwml soit depuis d'autres scripts, comme ceux qui extraient les manuels de certains paquets.