[Docs] Infrastuttura per la gestione della documentazione

Daniele Tricoli eriol a mornie.org
Ven 25 Maggio 2007 19:37:03 CEST


On Friday 25 May 2007, Alan Franzoni wrote:
> No... però ci ho dato un'occhiata e mi sono "innamorato" subito. LaTeX
> ancora non lo digerisco. Troppo macchinoso! 

IMHO LaTeX permette la gestione di un markup molto piu` complesso di 
quello reST, ma molto probabilmente per la documentazione non ci serva 
tanto potere ;)

> > E se in futuro ci accorgiamo dei limiti del nuovo formato, che si fa?
> > Buttiamo tutto quello già fatto?
>
> No, come detto c'è rst2latex. A quel punto prenderemmo la versione
> latex e ripartiremmo da quella.

Uhm... facendo il diff con la versione inglese converita?

> Comunque ti do ragione sulla giovinezza della cosa; quindi mi riservo
> di testare la conversione da/a latex entro il Pycon, in maniera da
> poter dare un giudizio più obiettivo sulla cosa, senza stare a
> discutere su una cosa che magari poi, all'atto pratico, è
> impraticabile.

Ottimo :D

> Io ho un'idea che avevo già proposto ad Eriol. In linea con gli
> obiettivi di Python Italia APS, vorrei fare una specie di campagna
> 'Adotta un pezzo di documento' al Pycon Uno.

+1

> In pratica, suddividendo la documentazione di Python non in linee
> arbitrarie (che incasinano un po' tutto, IMHO) vorrei assegnare un
> "mantainer" ad ogni capitolo, o sottocapitolo. Questo mantainer
> dovrebbe avere accesso diretto, esclusivamente per la sua sezione, ad
> un ipotetico (e ancora da definire) CMS per la documentazione di
> python.it (docs.python.it) e mantenere aggiornata (direttamente) la
> traduzione ad ogni versione. Se siamo d'accordo proporrei l'idea anche
> sulla ML dell'organizzazione di Pycon.

A me del sistema di Brandl e` piaciuto proprio la possibilita` delle diff 
modificabili da web che vanno vagliate e approvate dal team che si occupa 
della documentazione.

> Il coordinatore avrebbe quindi soltanto il ruolo di dare un'occhiata
> alle traduzioni revisionate ed eventualmente sollecitare i mantainer o
> assegnarne di nuovi quando i vecchi latitino.

Creare un vero e proprio team invece? Io l'ho notato con debian: dove vi 
e` un team che gestisce determinate cose (vedi python per fortuna) il 
tutto e` piu` rapido e` preciso.

> Ma ci sono anche gli output in html, o in puro testo... non lasciamoci
> prendere dalla foga del formato, l'importante è che, in un modo o
> nell'altro, i contenuti ci siano. Da me si dice "il meglio è nemico
> del bene". Quante volte per fare la "figata" si finisce per non
> combinare nulla? Fin troppe, secondo me (e mi includo al 100% in
> questa stima).

Penso che abbia proprio ragione Alan... considerare pure me in questa 
stima...

> Per quanto riguarda il coordinamento, se riusciamo a mettere insieme
> un buona infrastruttura e una buona squadra di mantainer per i
> documenti - e quindi il tempo di coordinamento non diventa un secondo
> lavoro a tempo pieno - io mi offro volontario. Certamente con
> l'infrastruttura attuale il casino è davvero eccessivo.

Ah, ok vedo che per l'idea di un team siamo d'accordo :)
Pure io mi offro volontario; spero anche di poter riprendere a tradurre 
costantemente...

> In ogni caso mi pare fondamentale coinvolgere tutti i soci di Python
> Italia nella gestione di python.it.

Concordo! (Anche se ancora non sono un socio... lo diventero` al PyCon ;)

> D'altronde tale sito non diventerà 
> il sito 'istituzionale' dell'associazione? E' giusto non pressare
> troppo prima del Pycon visto che c'è già molto, moltissimo lavoro da
> fare. Ma penso che il passo successivo sia proprio quello della messa
> a punto di python.it.

+1

Saluti!

-- 
 Daniele Tricoli 'Eriol'
 http://mornie.org


Maggiori informazioni sulla lista Docs