Le dépôt VCS du projet de documentation Debian (système de contrôle de versions)
- Accéder aux sources sur le dépôt Git
- Obtenir les privilèges de mise à jour
- Mécanisme de mise à jour automatique
Le Projet de documentation Debian stocke tous les contenus sur Salsa, l'instance GitLab de Debian. Pour accéder aux différents fichiers, voir les modifications récentes et l'activité du projet en général, veuillez visiter le dépôt du DDP.
Pour télécharger un manuel complet, un accès direct à Salsa est souvent la meilleure solution. Les paragraphes suivants expliquent comment cloner un dépôt Git (en lecture seule ou en lecture et écriture) sur votre machine et comment mettre à jour votre copie locale. Avant de commencer, vous devez installer le paquet git sur votre machine.
Cloner anonymement un dépôt Git (mode lecture seule)
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.
Astuce : Pour trouver l'URL correcte pour la commande
git clone
, ouvrez le projet dans un navigateur web, cliquez sur le
bouton bleu Clone et copiez l'URL Clone with HTTPS dans votre
presse-papier.
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.
Avec un accès en écriture pour Salsa, vous pouvez utiliser cette commande pour télécharger tous les fichiers d’un projet particulier :
git clone [email protected]: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 les sous-répertoires respectifs du manuel et lancez la commande :
git pull
Obtenir les privilèges de mise à jour
Les privilèges de mises à jour sont accordés à tous ceux qui désirent participer à l’écriture des manuels, des FAQ, des guides pratiques, etc. Nous demandons habituellement que vous ayez d’abord présenté quelques correctifs utiles. Après cela, suivez ces étapes pour demander l'accès en écriture :
- Créez un compte pour Salsa si ce n'est pas déjà fait ;
- Allez sur le dépôt DDP et cliquez sur Request Access ;
- Envoyez un courriel à la liste [email protected] et dites-nous vos antécédents dans le projet Debian ;
- Une fois votre requête acceptée, vous serez membre de l'équipe DDP.
Mécanisme de mise à jour automatique
Tous les manuels sont publiés comme des pages web générées automatiquement sur
www-master.debian.org dans le cadre du processus de reconstruction régulière du
site web qui se déroule toutes les quatre heures. Pendant ce processus, la
dernière version des paquets est téléchargée de l'archive, chaque manuel est
reconstruit et tous les fichiers sont transférés dans le sous-répertoire
doc/manuals/
du site web.
Les fichiers de la documentation générés par le script de mise à jour sont disponibles sur https://www.debian.org/doc/manuals/.
Les fichiers des journaux générés par le processus de mise à jour sont
disponibles sur https://www-master.debian.org/build-logs/webwml/
(le script s’appelle 7doc
et est exécuté dans le cadre d’une tâche
cron often
).