Skip to content

Commit e1c2f5a

Browse files
committed
feat: add new file tools
1 parent 46bb168 commit e1c2f5a

2 files changed

Lines changed: 93 additions & 1 deletion

File tree

docs/it/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,5 @@ Lo Standard ``publiccode.yml``
1010
forks.md
1111
pa-types.md
1212
tags.md
13-
strumenti.md
13+
tools.md
1414
example.rst

docs/it/tools.rst

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
.. _tools:
2+
3+
Strumenti
4+
=========
5+
6+
Lo standard `publiccode.yml` nasce dall'esigenza di facilitare il processo di
7+
ricerca, valutazione e riuso dei software all'interno della
8+
Pubblica Amministrazione.
9+
Per facilitarne la diffusione, il Team per la Trasformazione Digitale ha
10+
sviluppato una serie di strumenti che verranno descritti dinanzi.
11+
Prima di passare alla descrizione degli strumenti, è utile ricordare il flusso
12+
di lavoro da seguire per assicurare che il proprio progetto venga correttamente
13+
indicizzato all'interno del catalogo del riuso.
14+
15+
Flusso di lavoro
16+
~~~~~~~~~~~~~~~~
17+
18+
Il seguente flusso di lavoro è da considerarsi valido sia per il software
19+
a riuso delle Pubbliche Amministrazioni che per il software open-source di
20+
terzi. L'unica differenza sta nel punto `3`, relativo alla procedura di
21+
onboarding, in quanto la piattaforma ospitata su Developers Italia è pensata
22+
esclusivamente per essere usata da PA che si vengono classificate attraverso il
23+
proprio indice delle Pubbliche Amministrazioni (iPA).
24+
Come indicato nelle [Linee Guida su acquisizione e riuso di software per le
25+
Pubbliche
26+
Amministrazioni](https://lg-acquisizione-e-riuso-software-per-la-pa.readthedocs.io/it/latest/attachments/allegato-b-guida-alla-pubblicazione-open-source-di-software-realizzato-per-la-pa.html?highlight=publiccode#registrazione-del-repository-su-developers-italia),
27+
è necessario compilare e pubblicare il file `publiccode.yml` relativo al
28+
proprio progetto prima di registrarlo sul portale di Developers Italia. Qui di
29+
seguito verranno forniti maggiori dettagli riguardanti queste operazioni.
30+
31+
1. La prima operazione da effettuare consiste nella creazione del file
32+
`publiccode.yml`. Dopo aver consultato l'[ultima
33+
versione](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/schema.html)
34+
disponibile dello standard ed essersi assicurati di avere a disposizione
35+
almeno tutte gli elementi da indicare obbligatoriamente nel file,
36+
è possibile preparare il file `publiccode.yml` relativo al proprio
37+
progetto. Per evitare di scrivere direttamente un file in formato `yaml`, il
38+
Team per la Trasformazione Digitale ha realizzato uno strumento che facilita
39+
questa operazione, vedi :ref:`editor`.
40+
2. Una volta completata la compilazione del file `publiccode.yml`, è necessario
41+
inserire tale file nella radice del proprio repository pubblico (`root`).
42+
Quella, infatti, è la posizione nella quale il crawler si aspetterà di
43+
trovare un file `publiccode.yml` valido relativo al progetto.
44+
A seconda dello strumento di code hosting utilizzato (repository), potrebbe
45+
essere possibile effettuare questa operazione tramite l'interfaccia web. Si
46+
consiglia di consultare il manuale relativo al proprio repository per avere
47+
maggiori informazioni a riguardo.
48+
3. Dopo aver caricato il file all'interno del proprio repository, è possibile
49+
registrare l'applicazione sul :ref:`onboarding` di Developers Italia in modo tale che
50+
il crawler possa trovarlo ed elaborarne correttamente le informazioni.
51+
52+
.. _editor:
53+
54+
publiccode.yml editor
55+
~~~~~~~~~~~~~~~~~~~~~
56+
57+
L'applicazione che permette di generare e validare i propri `publiccode.yml`
58+
è l'[editor](https://publiccode-editor.developers.italia.it/). Lo scopo di
59+
questo editor è quello di guidare l'utente nella compilazione di una serie di
60+
form le cui informazioni andranno a confluire all'interno del file
61+
`publiccode.yml` rispettando l'[ultima
62+
versione](https://github.com/italia/publiccode.yml/releases/latest) disponibile
63+
dello standard. In questo modo, anche i non addetti ai lavori possono compilare
64+
il file `publiccode.yml` relativo al proprio applicativo. Una volta compilato, il file
65+
potrà essere scaricato in locale per poi essere caricato all'interno del
66+
proprio repository.
67+
68+
69+
.. _onboarding:
70+
71+
Portale di onboarding
72+
~~~~~~~~~~~~~~~~~~~~~
73+
74+
Il [portale di onboarding](https://onboarding.developers.italia.it/) permette
75+
di registrare la propria piattaforma di codice sorgente pubblico in modo tale da
76+
permettere al :ref:`crawler` di visitare i singoli repository alla ricerca del
77+
file `publiccode.yml`, estrarne le informazioni relevanti ed inserire una nuova
78+
scheda all'interno del catalogo del riuso.
79+
**Nota bene:** Sul portale di onboarding viene richiesto di inserire la URL
80+
dell'organizzazione creata all'interno della piattaforma di code hosting, e non
81+
il link relativo al singolo repository. Ad esempio, per quanto
82+
riguarda l'organizzazione chiamata *italia*, ospitata su GitHub, la URL
83+
è *https://github.com/italia*. Inserendo la URL dell'organizzazione, il
84+
:ref:`crawler` cercherà il file `publiccode.yml` nella radice (root) di tutti
85+
i repository ospitati al suo interno.
86+
87+
88+
.. _crawler:
89+
90+
Crawler
91+
~~~~~~~
92+

0 commit comments

Comments
 (0)