Docs Italia si basa su GitHub come strumento per pubblicare i documenti (e gestirne le versioni).
Per pubblicare un documento, è necessario avere:
- Un account utente su GitHub;
- Un’organizzazione su GitHub.
Se fai parte o lavori per un Ente pubblico e vuoi pubblicare i tuoi documenti su Docs Italia, hai bisogno prima di tutto di un account su GitHub. La registrazione è gratuita e può essere completata seguendo le istruzioni nella pagina ufficiale.
L’account su GitHub consente l’identificazione dell’utente e permette di effettuare tutte le operazioni in maniera sicura e tracciabile.
L’Ente pubblico deve essere associato a un’organizzazione su GitHub.
Come creare un'organizzazione su GitHub
Un’organizzazione è un insieme di repository gestiti da più utenti GitHub che collaborano a progetti comuni.
L’organizzazione rappresenta una modalità efficiente di raggruppare tutti i progetti digitali di un Ente pubblico. Offre, inoltre, alcuni vantaggi nella gestione dei permessi degli utenti e opzioni di sicurezza e amministrazione avanzate. Anche l’account organizzazione è gratuito e permette un numero illimitato di repository e collaboratori.
La :numref:`Figura %s <developer>` mostra la pagina dell’organizzazione Developers Italia su GitHub. È possibile notare il numero di repository aperti, le persone che collaborano con l’organizzazione e i team.
L'organizzazione Developers Italia su GitHub
Note
Se la tua amministrazione per qualche ragione non può creare un'organizzazione su GitHub, :ref:`contatta gli amministratori di Docs Italia <sec-amministratori>` per richiedere un repository nell'organizzazione di Developers Italia.
Docs Italia usa il version control system di Git, che permette di gestire le diverse versioni di un documento. La pubblicazione su Docs Italia richiede una conoscenza di base di Git e di alcuni termini collegati. Consulta il :ref:`Glossario minimo <sec-glossario>` in Appendice.
La pubblicazione di un documento su Docs Italia avviene secondo le seguenti fasi:
- L'amministrazione crea un'organizzazione su GitHub;
- L'amministrazione crea un repository di configurazione nella propria organizzazione;
- L'amministrazione richiede l'autorizzazione alla pubblicazione;
- L'amministrazione crea un repository del documento dove caricare la propria documentazione.
I primi tre passaggi sono richiesti soltanto al primo accesso a Docs Italia: in questo caso, le principali operazioni sono a carico degli amministratori della piattaforma.
Il caricamento e la modifica dei file contenuti nei repository di configurazione e di documento rientrano, invece, in un processo iterativo, che può essere svolto anche in maniera collaborativa. Consulta il capitolo su come pubblicare un documento per maggiori informazioni.
Le procedure di autorizzazione iniziali servono a verificare le credenziali dell’utente e a consentire la pubblicazione su Docs Italia soltanto alle amministrazioni autorizzate.
L’Ente che vuole pubblicare su Docs Italia crea un’organizzazione su GitHub dove ospiterà i repository per la propria documentazione.
Note
Requisiti per le organizzazioni
Per poter importare i repository di un'organizzazione su Docs Italia, un utente deve rendere pubblica la propria appartenenza all’organizzazione. Per controllare l’appartenenza bisogna visitare questo indirizzo
https://github.com/orgs/<nome-org>/people, avendo cura di sostituire<nome-org>con il nome della propria organizzazione. L’appartenenza a un'organizzazione è pubblica quando, nella scheda People della pagina dell'organizzazione, in corrispondenza del proprio nome compare la scrittaPublice nonPrivate.Per permettere a un utente membro di un'organizzazione di importare i repository dei documenti, è necessario rimuovere le restrizioni sulle applicazioni di terze parti dalle impostazioni di GitHub.
Dalla pagina dell'organizzazione, vai su Settings, Third-party access, quindi clicca sul pulsante Remove restrictions (vedi la :numref:`Figura %s <remove-restrictions>`). Di fianco a Policy apparirà la dicitura No restrictions.
Come rimuovere le restrizioni sulle applicazioni di terze parti per un'organizzazione su GitHub.
Dopo aver compiuto queste operazioni preliminari, è possibile seguire la procedura qui sotto.
Procedura
- Un amministratore dell’account organizzazione crea un apposito repository di configurazione chiamato italia-conf, contenente alcuni file necessari a identificare l'amministrazione, i progetti e i documenti che si desidera pubblicare su Docs Italia. :ref:`Maggiori informazioni sul repository di configurazione <sec-repo-config>` sono disponibili nel capitolo dedicato alla pubblicazione. Un esempio di repository di configurazione si trova nello :ref:`Starter kit <sec-starter-kit>` fornito.
- Un amministratore dell’account organizzazione invia una richiesta di autorizzazione alla pubblicazione su Docs Italia tramite Slack di Developers Italia, usando il canale #docs-italia.
- Gli amministratori di Docs Italia, effettuate le opportune verifiche, autorizzano l’organizzazione alla pubblicazione.
- Un amministratore dell’account organizzazione crea un repository per il documento. Il nome del repository deve rispettare le convenzioni sui nomi di Docs Italia. A questo punto può aggiornare il file document_settings.yml e caricare i file del documento secondo le modalità indicate nella sezione Repository del documento. Un esempio completo di repository del documento è contenuto nello Starter kit.
example
Processo di autorizzazione per organizzazioni GitHub
Il Ministero dell’Interno vuole pubblicare su Docs Italia un documento chiamato “Modalità di subentro”, relativo al progetto ANPR. Il Ministero dell’Interno ha un’organizzazione su GitHub, la cui amministratrice è Giulia Rossi.
- Giulia Rossi crea un repository di configurazione presso l’organizzazione GitHub del Ministero dell’Interno.
- Giulia Rossi invia la richiesta di autorizzazione alla pubblicazione su Docs Italia, e la sua richiesta viene approvata.
- Giulia Rossi crea, infine, un repository del documento presso l’organizzazione GitHub del Ministero dell’Interno, dove inserirà tutti i file relativi alla documentazione, aggiornando allo stesso tempo il file document_settings.yml.
Il nome del :ref:`repository del documento <sec-repo-doc>` deve seguire il formato: nomeprogetto-nomedocumento-docs.
Per esempio, un documento dal titolo “Istruzioni per il cambio di residenza” all’interno del progetto ANPR potrebbe essere ospitato nel repository anpr-cambioresidenza-docs.
Il nome deve sempre finire con -docs per segnalare che il repository contiene della documentazione.
Dopo aver creato i repository, è possibile caricare i file per generare la documentazione. Le procedure sono descritte nel capitolo :ref:`Pubblicare un documento <pubblicare-un-documento>`.
Docs Italia ha dei maintainer con dei privilegi di amministrazione che permettono loro qualsiasi intervento all’interno della piattaforma. Un maintainer di Docs Italia può, per esempio, gestire gli utenti e rimuovere dei documenti già pubblicati.
Tuttavia, nel caso in cui siano chiamati a supportare la creazione di un documento ospitato in un repository di un’organizzazione GitHub, i maintainer devono farsi autorizzare dagli amministratori del repository specifico.
Le attività di pubblicazione utilizzando GitHub e Docs Italia sono a carico dell’organizzazione e dell’utente. In caso di problemi, è possibile chiedere supporto al servizio assistenza di Docs Italia tramite Slack di Developers Italia usando il canale #docs-italia.