VCS (Sistema di Controllo Versione) del Progetto di Documentazione Debian
- Accedere ai sorgenti in Git
- Ottenere i privilegi di scrittura (Push)
- Meccanismo di aggiornamento automatico
Accedere ai sorgenti in Git
Il Progetto di documentazione di Debian raccoglie tutti i contenuti in Salsa, l'istanza GitLab di Debian. Per accedere a singoli file, controllare cambiamenti recenti e visualizzare altre attività del progetto, si prega di visitare il repository del DDP.
Per scaricare i manuali completi, l'opzione migliore è quella di avere accesso diretto a Salsa. Le prossime sezioni spiegheranno come clonare un repository Git (in sola lettura o in scrittura) sulla propria macchina e come aggiornare la propria copia locale. Come prerequisito si prega di installare il pacchetto git sulla propria macchina.
Clonare anonimamente il repository Git (in sola lettura)
Usare questo comando per scaricare tutti i file relativi a un progetto:
git clone https://salsa.debian.org/ddp-team/release-notes.git
Lanciare lo stesso comando per scaricare ogni altro progetto sul proprio
computer. Suggerimento: Per ottenere l'URL corretto da passare
al comando git clone
, aprire il progetto in un browser, fare click
sul bottone blu Clone with HTTPS e copiare l'URL negli appunti.
Clonare un repository Git con privilegi di push (lettura e scrittura)
Prima di avere accesso in lettura e scrittura al server Git, bisogna ottenere i diritti di scrittura sul repository. Si prega di consultare questa sezione per maggiori informazioni riguardanti la richiesta di permessi di scrittura (push).
Avendo i permessi di scrittura su Salsa, si può utilizzare il seguente comando per scaricare tutti i file di un progetto:
git clone git@salsa.debian.org:ddp-team/release-notes.git
Lanciare lo stesso comando per ogni progetto che si desidera clonare localmente.
Scaricare le modifiche dal repository Git remoto
Per aggiornare la propria copia locale con tutte le modifiche fatte da altri a un manuale, entrare nella corrispondente sotto cartella e lanciare il seguente comando:
git pull
Ottenere i permessi di scrittura (Push)
I permessi di scrittura sono disponibili a chiunque voglia partecipare alla stesura di manuali, FAQ (domande frequenti), howto, ecc. È generalmente richiesto l'invio di un paio di modifiche. Dopodiché, seguire questi passi per inoltrare la richiesta di accesso in scrittura:
- Creare un account su Salsa, se non lo si è già fatto.
- Andare al repository del DDP e fare click su Richiedi Accesso
- Inviare un'e-mail a debian-doc@lists.debian.org e comunicarci in che modo si ha contribuito al progetto Debian.
- Una volta che la richiesta sarà approvata, si farà parte del team DDP.
Meccanismo di aggiornamento automatico
Tutti i manuali sono pubblicati come pagine web. Queste sono generate
automaticamente su www-master.debian.org durante il periodico processo di
compilazione del sito web, pianificato ogni quattro ore. Durante tale processo,
la versione piú aggiornata è scaricata dall'archivio, ogni manuale
ricompilato e tutti i file trasferiti nella sotto cartella
doc/manuals/
del sito web.
I file di documentazione generati dallo script di aggiornamento si trovano all'indirizzo https://www.debian.org/doc/manuals/.
I file di log generati dal processo di update si trovano all'indirizzo https://www-master.debian.org/build-logs/webwml/ (lo script si chiama
7doc
e fa parte del cron job nominato often
).