Introduzione
Il codice sorgente del Wiki è ospitato su Launchpad nella pagina wiki-repo.
Di seguito vengono riportate le operazioni necessarie per interagire con la piattaforma, sia per gli aggiornamenti di routine sia per modifiche supplementari.
Requisiti
Avere installato il pacchetto bzr.
Avere impostato una chiave ssh su Launchpad come mostrato nella seguente pagina.
Procedura generale
Per scaricare nella propria Home la directory wiki-repo ospitata su Launchpad, procedere con i seguenti passaggi.
Identificarsi attraverso il software Bazaar con il comando nella forma:
bzr whoami "Nome Cognome <indirizzo_email>"
Se l'utente si chiama ad es. Mario Rossi e utilizza l'email m.rosssi@mail.com, il comando diviene:
bzr whoami "Mario Rossi <m.rossi@mail.com>"
Effettuare il login digitando il comando nella forma:
bzr launchpad-login nickname_launchpad
Se il nickname utilizzato su Launchpad è mario il comando diviene:
bzr launchpad-login mario
Scaricare la directory del wiki-repo nella propria Home digitando:
bzr branch lp:~ubuntu-it-wiki/wiki-ubuntu-it/wiki-repo
- Apportare le modifiche ai file interessati.
Spostarsi nella directory ~/wiki-repo:
cd ~/wiki-repo
Effettuare il commit per salvare le modifiche apportate nella revisione, avendo cura di inserire una brevissima descrizione dei cambiamenti:
bzr commit -m "Inserire_qui_breve_messaggio_descrittivo"
Eseguire in fine il push per caricare le modifiche sul server:
bzr push lp:~ubuntu-it-wiki/wiki-ubuntu-it/wiki-repo
Aggiungere file
Può capitare di dover aggiungere file, come ad esempio una nuova macro. In tal caso eseguire questi passaggi.
Eseguire i passi mostrati in precedenza fino al download della directory wiki-repo nella propria Home.
- Copiare il file all'interno della cartella di destinazione.
Spostarsi nella medesima cartella con il terminale digitando:
cd ~/wiki-repo/PERCORSO_DI_DESTINAZIONE
Dare quindi il comando:
bzr add NOME_FILE
sostituendo NOME_FILE con il vero nome del file.Sempre rimanendo nella medesima cartella eseguire commit e push come mostrato nel paragrafo precedente.
Attuare un merge
Può succedere che un utente con account Launchpad proponga delle migliorie da apportare al codice del wiki attraverso gli strumenti messi a disposizione da Launchpad stesso. In tal caso può apportare le migliorie su di un proprio branch e quindi richiedere un merge sul progetto originale.
Supponendo che un utente abbia creato il branch lp:~username/wiki-ubuntu-it/nome-branch e che abbia fatto una merge request, seguire questi passaggi per applicare le modifiche proposte.
Launchpad notificherà la richiesta agli amministratori, che potranno recarsi alla relativa pagina (pagina di esempio) per segnare lo stato come Approved e inserire in basso il commento merge-approved.
Dopo aver effettuato il login su Bazaar, scaricare entrambe le directory wiki-repo e nome-branch nella propria Home con i comandi:
bzr branch lp:~ubuntu-it-wiki/wiki-ubuntu-it/wiki-repo
bzr branch lp:~username/wiki-ubuntu-it/nome-branch
Spostarsi nella cartella wiki-repo:
cd ~/wiki-repo
Eseguire il merge con il comando:
bzr merge ~/nome-branch
Eseguire quindi commit e push:
bzr commit -m "Inserire_qui_breve_messaggio_descrittivo"
bzr push lp:~ubuntu-it-wiki/wiki-ubuntu-it/wiki-repo
Automaticamente lo status della richiesta passerà da approved a merged.
Altre modifiche
Per elaborare modifiche di vario genere, come ad esempio al tema grafico, è opportuno lavorare in locale su un'installazione di MoinMoin Desktop Edition. Per ricreare l'aspetto originario del wiki procedere con i seguenti passi:
Installare sul proprio sistema MoinMoin Desktop Edition.
Scaricare la directory wiki-repo.
Copiare i file di configurazione:
cp ~/wiki-repo/data/plugin/theme/light.py ~/mywiki/data/plugin/theme/
sudo cp -pR ~/wiki-repo/htdocs/light /usr/share/moin/htdocs/
Settare il parametro theme_default nel file ~/mywiki/wikiconfig.py nel seguente modo:
theme_default = 'light'
Perché la macro informazioni funzioni è necessario installare il pacchetto python-distro-info:
sudo apt install python-distro-info
copiare quindi le macro esistenti:
cp ~/wiki-repo/data/plugin/macro/*.py ~/mywiki/data/plugin/macro/
Creare una copia di backup del file favicon.ico:
sudo cp /usr/share/moin/htdocs/favicon.ico /usr/share/moin/htdocs/favicon_backup.ico
e quindi sostituire l'icona del wiki:
sudo cp -p ~/wiki-repo/htdocs/favicon.ico /usr/share/moin/htdocs/
Questi sono i principali file per attuare modifiche allo stile grafico del wiki:
light.py: internamente al codice Python si trova il codice html che costituisce la struttura dell'header e del footer del sito;
directory css: all'interno di questa cartella sono presenti i fogli di stile, in particolare i file common.css e screen.css. Qui è possibile settare le varie regole per il colore degli elementi, grandezza carattere, ecc..