Il repository è pensato per contenere le guide di uso interno dell'organizzazione GitHub e della community stessa.
- Come creare una nuova guida
- Come è fatta una guida
- Come proporre una nuova cartella
- Chi approva le modifiche
- Cos'è Markdown
- Tipologie di file
- Licenza
Le guide per poter essere aggiornate o modificate seguono un processo di revisione che si effettua tramite i ticket disponibili nel repo.
Per poter partecipare e suggerire nuove guide si possono seguire due procedimenti:
- Fare una pull request con la guida (guida in lavorazione nella cartella)
- Aprire un ticket e partecipare alla discussione
Le guide sono tematiche suddivise per cartelle. A seconda del soggetto possono essere in un unico file diviso per paragrafi oppure piu file sempre dentro la cartella dedicata.
Le cartelle sono pensate per categoria di argomento, quindi per poterne proporre una nuova è richiesta l'apertura di un ticket. Ogni cartella deve contenere un file readme che spiega perchè esiste.
Le modifiche sono approvate da un ristretto team di persone della community che si occupano della revisione delle eventuali decisioni, per poter farne parte bisogna partecipare nel canale #community del nostro Slack.
Il Markdown è una sintassi per i documenti che permette di visualizzarli in modo graficamente avanzato sfruttando solo del testo.
Le regole e sintassi di Markdown per GitHub si trovano su https://help.github.com/categories/writing-on-github/
In ambito di programmazione il linting é quella pratica che permette di verificare e correggere gli errori di stile del codice ma nel nostro caso del testo in modo che la sintassi e la struttura sia uniforme tra piu persone e nel tempo.
Questo lint al momento é eseguito manualmente da chi ha le capacità tecniche utilizzando lo script markdown-lint.sh che lo effettua in automatico su tutti i file.
In questo repo sono permessi solo file di tipo testuale puro ed immagini.
Il materiale disponibile sul repo è coperto dalla licenza GPL 3.0.