Documentazione¶
Questa documentazione cerca di essere completa ma il vostro contributo è prezioso
In ogni pagina trovate un link a destra con scritto “Sorgente della pagina”, potete vedere cosa sta scritto, copiare il sorgente, correggerlo e inviarcelo. Saremo ben contenti di integrarlo.
potete scaricare il repository mercurial della documentazione:
hg clone http://hg.argolinux.org/isi/isi-2.0/Ed inviarmi la patch con le vostre migliorie
Il pacchetto isi¶
Il comando qui sopra scarica sul vostro pc i sorgenti di ISI come repository mercurial per generare la documentazione per provare in locale il risultato.
Tutta la documentazione del sito è raccolta in un pacchetto debian isi-docs che potete installare con il comando:
apt-get install isi-docs
Contribuire alla documentazione¶
Per contribuire alla documentazione occorre scrivere usando il sistema di markup reST. Vedrete presto che questo è facile e viene molto naturalmente.
Occorrono però due passi:
Procurarsi il sorgente di isi-docs che è in un repository formato mercurial:
apt-get install mercurial hg clone http://hg.argolinux.org/isi/isi-docsModificare le pagine che stanno in docs, eventualmente aggiungerne ed inviarmi le modifiche
Per fare nel modo più comodo questo secondo passaggio, anche se non necessario, consiglio di installare sphinx:
sudo apt-get install subversion-tools python-docutils python-jinja python-dev svn co http://svn.python.org/projects/doctools cd doctools/trunk python setup.py installAvendo sphinx installato, dalla cartella isi-docs:
cd docs (editate i file) make htmlChe produce i file in formato html in docs/.build/html Chi ha diritto di accesso può committare i risultati, gli altri possono mandarmi un diff:
hg tip > patch hg diff >> patch mutt -a patch -s "RetIsiDoc: aggiunta documentazione" [email protected] < /dev/null
reST¶
Per contribuire alla documentazione vi conviene familiarizzare con la sintassi di reST , il linguaggio di markup usato.
Alcuni documenti interessanti sono:
- la quickref (cominciate da qui)
- la documentazione sulle direttive disponibili
- la markup specification
- la presentazione che segue