[Sprint 0] Diamo una mano al manuale

jhl.verona wrote:

Ho passato un pò di tempo cercando di capire "la via Drupalesque" (the Drupal way) trovando un sacco di immundizie, insieme a quache filo d'oro - per le più su questo sito. Ho anche dato un occhiata alla documentazione qui - e mi sembra che ha bisogno di un pò di amore...John

Grande Jhl!... è da un po' che stavamo discutendo della necessità incombente di rimettere in piedi un po di Guide in italiano per Drupalitalia, la mia idea è stata di mettere insieme un "gruppo" che si occupeà della produzione di testo per i manuali in italiano per drupal, personalmete ho prodotto qualcosa ma da solo è davvero molto molto complicato correggere eventuali errori, sviste o semplicemente mancanze in termini "comunicativi"...

Quindi accologo con grande piacere la proposta di JHON.

Mettere tutto su un'altro Hosting al momento non mi sembra il caso, almeno finchè la mole di dati lo permette, mi sembra opportuno inglobare tutto in DrupalItalia.

Le mie proposte iniziali:
- Abbiamo molto materiale per così dire "vecchia", andrebbe ripresa tutta e riadattata dove si può ai nuovi manuali;
- Secondo il mio modesto parere bisogerebbe inventarsi un metodo di revisione delle guide prodotte, nel senso che per evitare brutture, o semplice errori di cui tutti ne siamo Affetti bisognerebbe inventarsi una modalità di revisione reciproca per le ultime guide inserite....
-- Una buona idea per quest'ultima proposta era avere a disposizione una lista delle ultime guide "modificate" così che uno revisioni le ultime modifiche ed in qualche modo conferma o corregge l'ultima modifica effettuata;

OK anche per me.
Posso trovare un po' di tempo per contribuire.
Definiamo una lista di priorità e mettiamoci al lavoro (+1 per quella di John).

Vorrei aggiungere un paio di proposte:

1) visto che moltissime informazioni preziose si trovano sparse qua e la nel forum, si potrebbe aggiungere una semplice flag "howto" o "tutorial" o "documentazione" in modo che gli utenti con ruolo moderatore o contributore possano facilmente selezionare i post di valore che potrebbero quindi essere riassunti in una pagina. è un sistema velocissimo da impostare e da utilizzare e da cui si potrebbe partire per creare o integrare la documentazione vera e propria.

2) ribadisco che si potrebberotradurre le pagine di documentazione da drupal.org o altre fonti.

Buona idea,
quoto e partecipo attivamente.
Per quanto riguarda la stesura dei testi, avete mai visto/provato trac?
E' un sistema per il versionamento di documenti/file etc...
Noi in ufficio lo usiamo per la condiviose dei progetti, soprattutto quando ci mettono mano troppe persone.
Tra l'altro è free, ma un pochino rognoso da mettere su per chi non se ne intende.
Cmq io sarei anche per un piccolo capito riguardanti i moduli, tenendo conto che io mi occupo principalmente di creazione di moduli ad hoc.

Ciao

<a href="mailto:[email protected]" rel="nofollow">[email protected]</a> wrote:

OK anche per me.
Posso trovare un po' di tempo per contribuire.
Definiamo una lista di priorità e mettiamoci al lavoro (+1 per quella di John).

Vorrei aggiungere un paio di proposte:

1) visto che moltissime informazioni preziose si trovano sparse qua e la nel forum, si potrebbe aggiungere una semplice flag "howto" o "tutorial" o "documentazione" in modo che gli utenti con ruolo moderatore o contributore possano facilmente selezionare i post di valore che potrebbero quindi essere riassunti in una pagina. è un sistema velocissimo da impostare e da utilizzare e da cui si potrebbe partire per creare o integrare la documentazione vera e propria.

<a href="mailto:[email protected]" rel="nofollow">[email protected]</a> wrote:

2) ribadisco che si potrebberotradurre le pagine di documentazione da drupal.org o altre fonti.

Aran wrote:

Buona idea,quoto e partecipo attivamente.Per quanto riguarda la stesura dei testi, avete mai visto/provato trac?
E' un sistema per il versionamento di documenti/file etc.. Noi in ufficio lo usiamo per la condiviose dei progetti, soprattutto quando ci mettono mano troppe persone. Tra l'altro è free, ma un pochino rognoso da mettere su per chi non se ne intende.

Aran wrote:

Cmq io sarei anche per un piccolo capito riguardanti i moduli, tenendo conto che io mi occupo principalmente di creazione di moduli ad hoc.
Ciao

Una Alternative-direcotry italiana non sarebbe maligna come idea, ma non voglio uscire dal Topic principale di questo thread quindi direi che se la cosa interessa si può fare un altro Topic.

Quote:

Non perchè non è un buon sistema, ma semplicemente penso che l'amministrazione drupalitalia preferisca gestire tutto via Drupal ed la cosa mi sembra più semplice da gestire dal punto di vista generale, poi mi pare che Drupal abbia un sistema di revisioni?

hai ragione, visto che usiamo drupal, tanto vale usarlo per tutto eheheh.
Comunque trac si basa su SVN per il versionamento; comunque alla fine è il risultato che conta :-D

Aran wrote:

Quote:

Non perchè non è un buon sistema, ma semplicemente penso che l'amministrazione drupalitalia preferisca gestire tutto via Drupal ed la cosa mi sembra più semplice da gestire dal punto di vista generale, poi mi pare che Drupal abbia un sistema di revisioni?

hai ragione, visto che usiamo drupal, tanto vale usarlo per tutto eheheh.
Comunque trac si basa su SVN per il versionamento; comunque alla fine è il risultato che conta :-D

però nulla toglie di "pre-fabbricare" le bozze delle guide in git o SVN e collegarle qui, per esempio io creai mesi fa una rep su GitHub per alcune mie guide... andato in disuso per mancanza di collaboratori.

per iniziare da qui
http://github.com/kiuz/Drupal-Doc-ita

è una rep fatta mesi fa quindi non l'ho fatta per dire " sono arrivato prima io" :D, è solo un idea per proporre soluzione su cui muoverci....

io posso inserire documentazione nell'apposita area, quindi almeno per il momento, possiamo tutti indicare eventuali link e contenuti da poter aggiunere... con relativo autore.

Ma creare un'area dedicata solo ai manuali/howto?

la mia proposta di breve termine è:
- Facciamo creare una sezione apposita nel Forum
- Usiamo i therad per le guide: un paio di Topic per le linee guida, la lista delle guide utili da stendere
- mentre poi tutti gi altri rappresentato ogni Topic una guida che andrà poi corretta, ed ampliata attraverso le risposte, e quindi mano a mano eliminate le risposte ed aggiunto i conenuti a quello originale.... fino al momento di renderla operativa e spostarla in Documentazione

approvo

Ottimo ottimo ottimo!!! Tutto bene per le proposte, anche se procederei per una via più modulare: usare wikitools e consentire a tutti le modifiche. Anche se la sezione Documentazione mi pare una via appropriata.

1) forum (solo per le discussioni!!!!) - possibilmente temporaneo (wikitools consente la discussione). FATTO
2) installazione wikitools TODO
3) documentazione sotto forma di BOOKS e revisioni. TODO
4) flag per segnare documentazione. ottima idea. FATTO

d'accordo con quanto fin qui detto/fatto.
un dubbio: ma se si mette su un sistema collaborativo con i books/revisioni/diff (stile community.openatrium.com), c'è davvero bisogno di wikitools? forse solo per markdown et similia...o no?

un altro dubbio: la flag "documentazione" è globale o per user? l'accesso è per tutti gli authenticated users? attenzione: basta un troll qualsiasi per (s)flaggare tutto!

intanto mi metto a flaggare... ;)

Riassunto

[Todo] Argomenti

• installazione di un ambiente per Drupal sul proprio PC - cosa ti è servito per il tuo PC/OS
• Installazione di Drupal - creare il db, caricare il codice, settare il web server, et al
• un occhio al amministrazione - le voce principale, cosa fanno
• tipi di contenuti, contenuti, e presentazione - cosa sono, come crearli, cosa si vede
• il mondo menù - dispatching, menù, breadcrumbs, ecc
• estendere core - caricare un modulo contrib, caricare una tema contrib
• moduli e teme per l'amministrazione - admin, RootCandy, ecc.
• teme per il sito - themegarden, ecc, ecc.
• estendere i tipo di contenuto con il content construction kit - CCK come si usa, il suo mondo
• estendere la presentazione del contenuto - Views cos'è, come si usa, il suo mondo

[Info] Linee Guida

• Evitiamo codice, se possibile, links vanno benissimo;
• Cercare di attenersi agli argomenti proposti nella lista precedente, se si hanno in mente nuovi argomenti, prima proporli poi crearlo;
• Comprensione e brevità;
• Se non si ha tempo di terminare una bozza iniziale, non creare il nodo relativo;
• Ogniuno è libero a presentare un riassunto - tipo mashup;
• La prima bozza "presentabile" deve essere almeno esaustiva in modo generico sull'argomento trattat, vedi esempio di Wikipedia, se l'argomento è trattato in modo troppo superficiale solo per prendersi il merito viene eliminata;

[Discussione]

• Rastrellare la "vecchia" documentazioni alla ricerca di documenti da adattare al "presente;
• Non essenziale, ma chi vuole o gli riesce più semplice tradurre dal d.org ben venga;
• Fonti esterne, fare un elenco di link utili in modo da rastrellare anche queste;
• La "Faq" mi sembra più indicata al "sito", non a quello di cui si discute, ad ogni modo:
• Faq: Domanda in cui è specificato in modo preciso il problema e la domanda mentre la Risposta deve spiegare in modo altrettanto sintetico la soluzione;
• Documentazione: indicano la guida generica a Drupal in lingua italiana, che valla basi fino a cose più complesse ma che tratta essenzialmente della "spiegazione" del funzionamente, obiettivo teoria, funzionamento di Drupal o di alcune sue componente, non si spiega come realizzare qualcosa;
• Guida / How to / Tutorial: si possono usare in documentazione che spiega in modo più vasto e meno tecnico "come realizzare un.. " ... con obiettivo il risultato, si spiega come fare a realizzare, risolvere o aggiungere qualcosa a Drupal;

mmmm però bisognerebbe distinguere d5 con d6.

Aran wrote:

mmmm però bisognerebbe distinguere d5 con d6.

<a href="mailto:[email protected]" rel="nofollow">[email protected]</a> wrote:

d'accordo con quanto fin qui detto/fatto.
un dubbio: ma se si mette su un sistema collaborativo con i books/revisioni/diff (stile community.openatrium.com), c'è davvero bisogno di wikitools? forse solo per markdown et similia...o no?

books/revisione/diff abilitato per tutti! Usatelo saggiamente :D

un altro dubbio: la flag "documentazione" è globale o per user? l'accesso è per tutti gli authenticated users? attenzione: basta un troll qualsiasi per (s)flaggare tutto!

intanto mi metto a flaggare... ;)[/quote]

per utente :P accessibile agli authenticated. Almeno per ora.

Si accettano consigli sull'input filter da usare.

noi segnalammo, voi spuntaste, essi flaggarono :-D

jhl.verona wrote:

Sia ma non ho ancora capito dove vedo la lista dei thread flaggati come documentazione...
Flaggati? Verbo flaggare (irregolare) io segnalo, tu spunti, lui flagga...

due grezze viste
http://www.drupalitalia.org/mod/doc
http://www.drupalitalia.org/mod/flag

jhl.verona wrote:

Psicomante wrote:

due grezze viste
http://www.drupalitalia.org/mod/doc
http://www.drupalitalia.org/mod/flag

Appena visto, grazie. Va benissimo cosi. Penso che dopo qualche giorno d'uso, torneremo a tormentati di nuovo ;-)[/quote]

Per così poco ^^

Da approvare / Commentare

Direi ottima l'idea (se non sbaglio di JOHN) di dare una struttura standard ai nomi della documentazione

[{D5|D6|D7} - {VERSIONE APPROSSIMATIVA}] NOME_DOCUMENTAZIONE

es:
[D5 - Alpha] Creare un Blocco
[D6 - Alpha] Inserira una Vista
[D5 - D7 - Beta] Stilare una Vista

Se per voi va bene direi di inserire la "versione" solo in caso sia Beta o Alpha, nel senso che esse indicano che hanno bisogno di revisioni per correggere errori palesi. Una volta revisionate e eliminati gli errori grossolani possiamo anche evitare di inserire "versione" doprattutto per non creare problemi di indicizazione con i Crawler.

la versione di Drupal non è necessaria dato che se ne occupa la tassonomia. Per la revisione (alpha,beta,buh,ciccio, pasticcio) è la stessa cosa, anche se per ora la tassonomia per quello non è stata ancora definita.

jhl.verona wrote:

Capisco il problema crawler, ma una volta stabilito il documento (e quindi titolo) avrà anche più 'valore' SEO.
Stiamo (non so chi l'inventò, forse Aran) usando:
[{D5|D6|D7} - {TIPO} - {VERSIONE APPROSSIMATIVA}] NOME_DOCUMENTAZIONE
es:
[D5 - HOWTO - Alpha] Creare un Blocco
[D6 - FAQ - Alpha] Moduli per principianti
[D5 - GUIDA - Beta] Come usare le Viste

Va bene così?

io eliminerei HOW To, FAQ, GUIDA, abbiamo già delle sezioni appositamente create, si verrebbero a creare solo termini superflui

mah non capisco la questione SEO. Si che ho fatto un talk sul SEO, ma qui si parla di Documentazione. Deve essere comprensibile per l'utente e un titolo con quella sintassi non lo è. Soprattutto in caso di cambiamenti ecc. Esistono le tassonomie: usiamole.

Ovviamente è una mia opinione.