Skip to content

Commit

Permalink
Deploy to GitHub pages
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] authored Jun 18, 2024
0 parents commit f888f5e
Show file tree
Hide file tree
Showing 148 changed files with 58,144 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 874b34b3303b48c37232a2a6fddda85a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/docs/come-contribuire.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/docs/come-utilizzare-le-risorse.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/docs/credits.doctree
Binary file not shown.
Binary file added .doctrees/docs/funzionamento-generale.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/docs/manuale-operativo.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/docs/premesse.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/docs/premesse/cosè-il-catalogo.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
Binary file added _images/image1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image10.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image11.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image12.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image13.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image14.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image15.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image5.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image6.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image7.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image8.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/image9.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions _sources/docs/come-contribuire.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Come contribuire
================

La sezione descrive il processo di contribuzione a cui i
soggetti individuati in `Attori <funzionamento-generale/attori.html>`__ possono
prendere parte.

.. toctree::
:maxdepth: 3
:caption: Indice dei contenuti

come-contribuire/attività-propedeutiche-alla-contribuzione-al-catalogo.rst
come-contribuire/richiesta-formale-di-contribuzione.rst
come-contribuire/contribuzione-continua-al-catalogo.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
Attività propedeutiche alla contribuzione al Catalogo
=====================================================

Le attività propedeutiche alla contribuzione al Catalogo da parte di un
Contributore sono:

- Effettuare un’analisi delle risorse da creare, oppure delle possibili
proposte di modifica da effettuare per risorse già pubblicate sul
catalogo;

- Individuare la modalità di contribuzione più consona al caso
specifico sulla base delle informazioni contenute nelle sotto-sezioni
seguenti eventualmente richiedendo supporto agli Amministratori del
Catalogo;

- Effettuare le ulteriori azioni di competenza descritte nel seguente flowchart.

.. mermaid::

flowchart TB
classDef default stroke:white,color:#fff,clusterBkg:none,fill:#3344d0
classDef cluster font-weight: bold,fill:none,color:darkgray,stroke:#3344d0,stroke-width:2px
classDef subgraph_padding fill:none, stroke:none, opacity:0
classDef bounded_context stroke-dasharray:5 5
subgraph b["Amministratori del Catalogo"]
id0["Analisi della richiesta di contribuzione espressa"]
end
subgraph Organizzazione Contributrice

id1((START))--> id2["Individuazione degli asset da creare o modificare"]
id2--> id3{"Difficoltà nel determinare la modalità"}
id3--> |Sì|id4["Organizzazione chiede supporto per determinare la modalità più opportuna"]
id4-.-> id0
id3--> |No|id5["Individuazione della modalità di contribuzione"]
id0-.->id5
id5--> id6{"Modalità di contribuzione"}
id6--> |Richiesta di semantic stewardship|id7["Invia richiesta di contribuzione al Catalogo utilizzando l'apposita email"]
id6--> |Aggiornamento/Creazione asset semantici|id8["Verifica sul Catalogo di risorse semantiche correlate"]
id8--> id9{"Presenza della risorsa"}
id9--> |Aggiunta di nuove risorse|id30["Scelta del dominio sotto cui pubblicare"]
id30--> id31{"Soluzione URI stabili già implementata dall'organizzazione"}
id9--> |Modifiche a risorse già a Catalogo|id10["Apertura Issue sul repository relativo all'asset da modificare"]
id10--> id11["Per lo sviluppo della proposta, riferirsi al Manuale Operativo"]
direction TB
id31--> |Sì|id15["Modellazione e metadatazione degli asset"]
id15--> id16["Predisposizione del repository git"]
id16-->id17["Utilizzo della propria soluzione per le URI stabili"]
id17-->id18["Test dei requsiiti tecnici per l'harvesting degli asset semantici"]
id31--> |No| id42["Valutazione risorse da pubblicare"]
id42--> id43{"Tipologia risorsa"}
id43--> |Risorse con elevato livello di generalità|id44["Riferirsi alle indicazioni nel wiki del repository nazionale"]
id43--> |Risorse non caratterizzate da elevato livello di generalità|id46["Modellazione e metadatazione degli asset"]
id46-->id47["Predisposizione del repository git"]
id47-->id48["Implementazione redirect su URI stabili sotto w3id"]
id48-->id49["Test dei requsiiti tecnici per l'harvesting degli asset semantici"]
id49-->id50((END))
id18-->id40((END))
id7--> id20((END))
id11-->id41((END))
id44-->id45((END))
end
Diagramma delle attività propedeutiche alla contribuzione

Aggiunta di nuove risorse
-------------------------

Di seguito il dettaglio delle attività propedeutiche del Contributore
per l’aggiunta di nuove risorse sul Catalogo:

- Se vuoi **registrare URI sotto il** ``w3id.org/italia``:

* Nel caso in cui si abbiano a disposizione risorse da pubblicare
caratterizzate da un elevato livello di generalità e
riutilizzabilità su scala nazionale, allora si potranno registrare
URI sotto ``w3id.org/italia``, beneficiando dei meccanismi di *URI
dereferentiation* e *Content Negotiation* già implementate. A tale
scopo, fai riferimento alle istruzioni contenute nel `repository
Italia <https://github.com/italia/daf-ontologie-vocabolari-controllati>`__
e alle indicazioni rese disponibili nel
`manuale operativo <../manuale-operativo/indicazioni-su-modellazione-e-metadatazione-degli-asset-semantici.html>`__
su come modellare e metadatare le risorse.

* Nel caso in cui le risorse da pubblicare non siano caratterizzate
da un elevato livello di generalità e riutilizzabilità su scala
nazionale, allora si potranno registrare URI sotto
``w3id.org/italia/<dominio_specifico>``. In tal caso, le istruzioni
sono le seguenti:

+ Per la **modellazione e metadatazione**, fai riferimento alle
indicazioni differenziate per tipologia di risorsa (vocabolario
controllato, ontologia o schema dati) contenute nel `manuale operativo <../manuale-operativo/indicazioni-su-modellazione-e-metadatazione-degli-asset-semantici.html>`__;
+ Per la **predisposizione del repository**, fai riferimento alle
indicazioni riguardo la struttura del repository da creare e
che verrà registrato tra le sorgenti del Catalogo. I file
richiesti, il versionamento e ulteriori dettagli sulle risorse
semantiche sono contenute nel `manuale operativo <../manuale-operativo/istruzioni-su-come-predisporre-il-repository-in-cui-pubblicare-le-risorse-semantiche.html>`__;
+ Per **l’implementazione del redirect degli URI stabili,** fai
riferimento alla soluzione descritta nel `manuale operativo <../manuale-operativo/identificativi-univoci-delle-risorse.html>`__;
+ Per il **test dei requisiti tecnici per l’harvesting delle
risorse semantiche**, fermo restando che il Contributore è
responsabile dei contenuti pubblicati nel proprio repository, è
necessario verificare che le risorse semantiche soddisfino i
requisiti tecnici richiesti per l’avvio della fase di
harvesting da parte del Catalogo. Per supportare al meglio i
Contributori in tale processo, gli Amministratori del Catalogo
sono al lavoro su una pagina web “\ **Strumenti di
validazione**\ ”, che suggerirà per ciascun use-case il
validatore più consono da poter utilizzare. In particolare, (i)
per i file ``index.ttl`` degli schemi dati e per le ontologie
verrà indicato il validatore in fase di sviluppo da parte degli
Amministratori del Catalogo; (ii) per i vocabolari controllati
si potrà utilizzare il `validatore DCAT-AP_IT sviluppato da
AGID <https://portaledati3-130.dati.gov.it:3030/dcat-ap_validator.html>`__
ignorando eventuali warning ed errori sulla presenza della
classe ``dcatapit:Catalog`` e sull’uso della proprietà
``owl:versionInfo`` quando più lingue vengono specificate per la
proprietà. In aggiunta, verrà indicato il validatore delle
OpenAPI (`Italian API Guidelines
Checker <https://italia.github.io/api-oas-checker/>`__), ovvero
per i file ``.yaml``. I controlli implementati dal validatore,
attualmente in sviluppo da parte degli Amministratori, saranno
un sottoinsieme di quelli eseguiti in fase di harvesting dalla
piattaforma Catalogo; in particolare, i controlli
verificheranno la presenza dei metadati mandatori nel file
turtle e la validità dei prefissi rispetto alle relative
ontologie. Infine, per un test di visualizzazione e di
correttezza delle risorse semantiche rispetto ai requisiti
tecnici per l’harvesting espressi nel `manuale
operativo <../manuale-operativo.html>`__, è possibile richiedere,
utilizzando la mail [email protected], un primo
aggiornamento nell’ambiente di test del Catalogo e, al termine
della fase di test, richiedere l’harvesting in produzione.

- Se vuoi **registrare URI in domini come** ``w3id.org/<dominio_specifico>``:

* Segui le istruzioni contenute nell’elenco al punto precedente. Per
l’attività di implementazione del redirect su URI stabili, puoi
far riferimento alla `guida ufficiale pubblicata dal
w3id <https://w3id.org/>`__. Inoltre, per la creazione dei file di
configurazione del redirect, puoi considerare **a titolo
esemplificativo** le istruzioni contenute nel
`manuale operativo <../manuale-operativo/identificativi-univoci-delle-risorse.html>`__.

- Se vuoi **registrare URI in domini proprietari**:

* Segui autonomamente tutte le specifiche richieste.

- Se vuoi **chiedere semantic stewardship a Istat**:

* Invia una richiesta di contribuzione al Catalogo utilizzando la
mail [email protected].

Richiesta di modifica di risorse già in Catalogo
------------------------------------------------

Se vuoi **suggerire una modifica a un contenuto semantico già esistente
nel Catalogo,** fai riferimento al
`manuale operativo <../manuale-operativo/indicazioni-su-aggiornamento-di-asset-semantici-esistenti.html>`__.
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Contribuzione continua al Catalogo
==================================

Una volta che i Contributori hanno aderito al Catalogo, questi hanno la
possibilità di espandere continuamente il proprio insieme di risorse
semantiche all'interno del Catalogo. Questo significa che possono
contribuire con delle nuove in diversi momenti successivi all'adesione
iniziale.

Tuttavia, è importante considerare che tutte le modifiche apportate al
proprio repository principale dopo l'adesione iniziale sono integrate
automaticamente dall'harvester ogni volta che viene attivato. Di
conseguenza, ogni modifica effettuata nel repository principale verrà
incorporata in produzione all'attivazione successiva dell'harvester.

Per mitigare questo aspetto, i Contributori possono scegliere di
caricare le risorse semantiche che non considerano stabili o complete in
un branch separato, e non nel branch master. Solo quando le ritengono
stabili e complete, possono eseguire il merge o il push nel branch
master per far sì che vengano integrate in produzione e, di conseguenza,
raccolte nel Catalogo.
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Richiesta formale di contribuzione
==================================

Una volta individuata la modalità di contribuzione più opportuna, e
portate a termine le relative attività descritte nelle precedenti
sezioni, contatta gli Amministratori del Catalogo per richiedere
formalmente di contribuire utilizzando la mail
[email protected]. Una volta avvenuto il contatto, verrà
organizzato un kick-off tra Amministratori e Contributore. È in corso di
implementazione, da parte degli Amministratori del Catalogo, una Pagina
Contatti che integrerà appositi wizard per fornire una procedura guidata
ed automatizzata di iscrizione ai Contributori.
40 changes: 40 additions & 0 deletions _sources/docs/come-utilizzare-le-risorse.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Come utilizzare le risorse
==========================

Schema.gov.it è il portale del Catalogo che abilita i Contributori,
oltreché qualsiasi cittadino, a ricercare, consultare e riusare gli
asset semantici (ontologie, schemi dati e vocabolari controllati).

In particolare, il portale del Catalogo offre funzionalità di ricerca e
strumenti integrati di visualizzazione e fruizione delle risorse allo
scopo di semplificare le attività di riuso delle stesse, ad es.
l’integrazione dei contenuti semantici all’interno degli e-service.

Il portale del Catalogo è pubblico, ovvero consultabile da chiunque, con
scopi anche diversi tra i vari fruitori. Di seguito alcuni esempi di
utente tipo del Catalogo:

- **sviluppatore di e-service**: può beneficiare del Catalogo
riutilizzando i concetti semantici al fine di sviluppare e-service che
siano interoperabili non solo sintatticamente, ma anche semanticamente;

- **ricercatore**: può beneficiare del Catalogo riutilizzando ontologie,
vocabolari e schemi per i propri scopi di ricerca, riducendo i tempi di
realizzazione di eventuali sperimentazioni;

- **contributore del Catalogo:** il beneficio è quello di poter
individuare eventuali ontologie, vocabolari o schemi strettamente
correlati, se non sovrapposti, ai contenuti semantici da pubblicare. In
questo modo, piuttosto che creare ex-novo risorse semantiche ridondanti
tra loro, è possibile estendere quelle esistenti, riducendo anche il
carico di lavoro annesso.

Le successive sotto-sezioni hanno lo scopo di descrivere le funzionalità di
ricerca e fruizione dei contenuti esposte dal portale del Catalogo.

.. toctree::
:maxdepth: 3
:caption: Indice dei contenuti

come-utilizzare-le-risorse/ricerca-di-risorse-semantiche.rst
come-utilizzare-le-risorse/scheda-della-risorsa-semantica.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
Ricerca di risorse semantiche
=============================

La ricerca degli asset semantici può essere effettuata direttamente
sull’homepage del Catalogo utilizzando l’apposito *textbox*, oppure
selezionando sulle diverse categorie o tipologie degli asset semantici,
come illustrato nella figura sottostante.

.. figure:: ../../media/image3.png
:alt: Homepage di schema.gov.it – Ricerca asset semantici
:width: 5.71198in
:height: 2.89375in

Homepage di schema.gov.it – Ricerca asset semantici

La ricerca tramite textbox permette agli utenti del Catalogo una rapida
individuazione delle risorse desiderate, fornendo in input le **parole
chiave** di interesse; in particolare, la *textbox* è supportata da
appositi indici che abilitano la ricerca testuale per titolo, *keyword*,
termini contenuti nella descrizione, titolare e concetti principali
della risorsa.

.. figure:: ../../media/image4.png
:alt: Homepage di schema.gov.it – Ricerca asset semantici (**Esplora il catalogo**)
:width: 6.13542in
:height: 2.1057in

Homepage di schema.gov.it – Ricerca asset semantici (**Esplora il catalogo**)

In aggiunta alla precedente modalità di ricerca, è possibile cliccare su
**Esplora il catalogo** e di conseguenza accedere ad una pagina di
ricerca avanzata che ne estende le funzionalità di filtraggio delle
risorse.

.. figure:: ../../media/image5.png
:alt: Catalogo – Ricerca asset semantici a partire da **Esplora il catalogo**
:width: 5.30208in
:height: 3.90625in

Catalogo – Ricerca asset semantici a partire da **Esplora il catalogo**

In particolare, è possibile filtrare le risorse per:

- **parole chiave**: la funzionalità di ricerca è analoga a quella
descritta per la homepage, ma in questo caso può essere coadiuvata dalle
successive.

- **tipologia**: tutte (opzione di default), ontologia, vocabolario
controllato, schema.

- **categoria**: ad esempio Energia, Ambiente, Trasporti.

- **titolare**: ad esempio INPS, ISPRA, AIA.

L’utente può configurare uno, più o tutti i filtri per poi cliccare il
tasto **OK** e ottenere i risultati della propria ricerca.

Inoltre, l’utente può rimuovere filtri applicati nella ricerca
precedente servendosi delle filter chip mostrate appena sotto gli
elementi di configurazione della ricerca, e/o aggiungere nuovi valori ai
filtri, per poi cliccare **OK** e ottenere i nuovi risultati di ricerca.

Per ciascun risultato di ricerca, l'utente visualizza le anteprime delle
risorse individuate (nessuna se il filtraggio è troppo restrittivo); per
ciascuna di esse, è possibile cliccare il titolo e accedere alla
relativa scheda di dettaglio. Ulteriori dettagli sulle schede dettaglio
degli asset semantici sono forniti nelle sotto-sezioni seguenti.
Loading

0 comments on commit f888f5e

Please sign in to comment.