Release core-0.2/it-0.2

Release core-0.2/it-0.2

Author: libremente

CHANGELOG.md

@@ -1,6 +1,27 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [core-0.2/it-0.2] - 2019-03-13
+### Added
+- A new `piattaforme` section has been created to group the platforms inside of
+  it.
+
+### Changed
+- The `conforme/accessibile` key becomes `conforme/lineeGuidaDesign` since it
+  is more self-explanatory.
+- The `conforme/interoperabile` key becomes `conforme/modelloInteroperabilita`
+  since it is more self-explanatory.
+- The `conforme/sicuro` key becomes `conforme/misureMinimeSicurezza` since
+  before it was rather vague and incomplete.
+- The `conforme/privacy` key becomes `conforme/gdpr` since the `privacy` term
+  is quite vague and incomplete.
+
+### Removed
+- The `ecosistemi` key has been removed since its values are already present in
+  the `intendedAudience/scope` key.
+- The `designKit` section has been removed since we will track the design kits
+  usages by means of the crawler.
+
 ## [core-0.2] - 2019-03-11
 ### Added
 - A new `countryExtensionVersion` key was added under each country-specific extension, in order to separate their versioning from the core.
@@ -11,7 +32,7 @@ All notable changes to this project will be documented in this file.
 - `tags` was replaced by `categories` (with a different dictionary of values).
 - BCP47 is now used for languages instead of ISO 639-2, thus keys under `description` will now look like `en` instead of `eng`
 - `publiccode-yaml-version` was moved to `publiccodeYmlVersion` using camelCase
-- `maintainance/contacts` is now mandatory only if `maintainance/type` is `internal` or `community`.
+- `maintenance/contacts` is now mandatory only if `maintenance/type` is `internal` or `community`.
 - All files ported to RST from previous MD
 
 ### Removed

README.it.md

@@ -1,33 +1,37 @@
 # Lo Standard `publiccode.yml`
 
-`publiccode.yml` è uno standard di metadati adatto a repository
-di software pubblico e di policy. Questo standard ha lo scopo
-di rendere il software sviluppato dalle Pubbliche Amministrazioni e Pubbliche
-Organizzazioni facile da individuare e, di conseguenza, riutilizzare. Proprio
-per questo motivo, è stato pensato per essere semplice da adottare sia per gli
-sviluppatori che per i non addetti ai lavori. 
+[![GitHub release](https://img.shields.io/github/release/italia/publiccode.yml.svg?style=plastic)](https://github.com/italia/publiccode.yml/releases)
+[![Join the #publiccode channel](https://img.shields.io/badge/Slack%20channel-%23publiccode-blue.svg)](https://developersitalia.slack.com/messages/CAM3F785T)
+[![Get invited](https://slack.developers.italia.it/badge.svg)](https://slack.developers.italia.it/)
+[![Docs
+Italia](https://docs.italia.it/media/static/projects/badges/passing.svg)](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/index.html)
+[![Documentation](https://img.shields.io/badge/Documentation-Docs%20Italia-blue.svg)](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/index.html)
 
-## Versioni
+> Uno standard di descrizione di metadati per software pubblico 
 
-**Ultimo rilascio: [Versione
-0.1](https://github.com/italia/publiccode.yml/releases/latest)**
+*Read this in [English](README.md).*
 
-[Vedi tutte le versioni](https://github.com/italia/publiccode.yml/releases)
+---
 
-Questo progetto aderisce al modello di versioning [*Semantic
-Versioning*](https://semver.org/).
+## Table of Contents
 
-Inoltre, questo progetto usa i *branch* e i *tag* di git nel seguente modo:
-* il branch `master` contiene l'ultima versione stabile dello standard;
-* il branch `development` contiene gli aggiornamenti proposti e in discussione
-  per la prossima versione dello standard;
-* La [release page](https://github.com/italia/publiccode.yml/releases) di
-  GitHub contiene tutte le versioni rilasciate dello standard. Le *release*
-  sono effettuate seguendo il nome del tag per questioni di coerenza (ad es.,
-  il tag `v0.1` implica una release denominata `v0.1`). 
+- [Descrizione](#descrizione)
+- [A cosa serve questo file](#a-cosa-serve-questo-file)
+- [Documentazione](#documentazione)
+- [Trovare progetti](#la-ricerca-dei-progetti)
+- [Versioning](#versioning)
+- [Contributing](#come-contribuire)
+- [Autori](#autori)
+- [License](#license)
 
-Le specifiche `publiccode.yml` sono sviluppate dal [Team per la Trasformazione
-Digitale](https://teamdigitale.governo.it) e dagli [Autori](AUTHORS.md).
+## Descrizione
+
+`publiccode.yml` è uno standard di metadati adatto a repository
+di software pubblico e di policy. Questo standard ha lo scopo
+di rendere il software sviluppato dalle Pubbliche Amministrazioni e Pubbliche
+Organizzazioni facile da individuare e, di conseguenza, riutilizzare. Proprio
+per questo motivo, è stato pensato per essere semplice da adottare sia per gli
+sviluppatori che per i non addetti ai lavori. 
 
 ## A cosa serve questo file
 
@@ -56,6 +60,14 @@ Il formato del file `publiccode.yml` è pensato per essere facilmente aggiunto
 ad ogni nuovo progetto e potrà cambiare ed adattarsi ai cambiamenti rispetto al
 contesto nel quale è stato originariamente sviluppato. 
 
+## Documentazione
+
+Questo repository è strutturato per essere compatibile con [Docs Italia](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/index.html).
+Per questo motivo, il contenuto delle rilevanti cartelle sarà compilato
+e renderizzato all'interno di tale piattaforma. `Docs Italia` è progettato per
+supportare un documento localizzato in diverse lingue e per questo motivo è la
+piattaforma di riferimento per visualizzare questo standard.
+
 ## La ricerca dei progetti
 
 La ricerca dei progetti dipende da come le API sono state strutturate per ogni
@@ -70,11 +82,42 @@ Il Team per la Trasformazione Digitale sta anche lavorando per fornire uno
 scanner che cerchi tutti i file `publiccode.yml` su tutti i siti accessibili
 pubblicamente, per poi pubblicarli sotto forma di open data. 
 
+## Versioning
+
+**Ultimo rilascio:** [![GitHub release](https://img.shields.io/github/release/italia/publiccode.yml.svg?style=plastic)](https://github.com/italia/publiccode.yml/releases) [See all versions](https://github.com/italia/publiccode.yml/releases)
+
+[Vedi tutte le versioni](https://github.com/italia/publiccode.yml/releases)
+
+Questo progetto aderisce al modello di versioning [*Semantic
+Versioning*](https://semver.org/).
+
+Inoltre, questo progetto usa i *branch* e i *tag* di git nel seguente modo:
+* il branch `master` contiene l'ultima versione stabile dello standard;
+* il branch `development` contiene gli aggiornamenti proposti e in discussione
+  per la prossima versione dello standard;
+* La [release page](https://github.com/italia/publiccode.yml/releases) di
+  GitHub contiene tutte le versioni rilasciate dello standard. Le *release*
+  sono effettuate seguendo il nome del tag per questioni di coerenza.
+
+Siccome questo repository contiene sia lo schema `core` che quelli contenenti
+le estensioni per ogni paese, è necessario adottare una strategia di versioning
+più raffinata. Per questo motivo, ogni update al core e/o ad un'estensione
+specifica per Paese, sarà taggata come segue:
+
+> core-x.y.z/cc-a.b.c
+
+dove cc rappresenta il codice del paese presente nella chiave
+`countryExtensionVersion` dello schema modificato. 
+
 ## Come contribuire 
 
 Sentitevi liberi di aprire delle [Pull Requests e di presentare un problema
 con una Issues](CONTRIBUTING.md).
 
+## Autori
+Le specifiche `publiccode.yml` sono sviluppate dal [Team per la Trasformazione
+Digitale](https://teamdigitale.governo.it) e dagli [Autori](AUTHORS.md).
+
 ## Licenza
 
 Il progetto è coperto da una licenza [CC-0](LICENSE).

README.md

@@ -9,6 +9,8 @@ Italia](https://docs.italia.it/media/static/projects/badges/passing.svg)](https:
 
 > A metadata description standard for public software
 
+*Leggi questo documento in [Italiano](README.it.md)*
+
 ---
 
 ## Table of Contents
@@ -97,10 +99,9 @@ country-specific ones, it is necessary to further refine the versioning.
 As such, each update at the core and/or to a country-specific extension will be
 tagged as follows:
 
-> core:x.y.z/<cc>:a.b.c
+> core-x.y.z/cc-a.b.c
 
-where <cc> is the country code defined using one of the ISO 3166-1 alpha-2
-codes. 
+where cc is the country code defined in the `countryExtensionVersion` key. 
 
 This versioning schema is fundamental in this project since the
 `publiccode.yml` file contains references to the core release in the

docs/en/example/publiccode.minimal.yml

@@ -1,4 +1,4 @@
-publiccodeYmlVersion: "0.1"
+publiccodeYmlVersion: "0.2"
 
 name: Medusa
 url: "https://example.com/italia/medusa.git"

docs/en/example/publiccode.yml

@@ -1,4 +1,4 @@
-publiccodeYmlVersion: "0.1"
+publiccodeYmlVersion: "0.2"
 
 name: Medusa
 applicationSuite: MegaProductivitySuite
@@ -120,27 +120,19 @@ dependsOn:
       optional: yes
 
 it:
-
-  countryExtensionVersion: 0.1
+  countryExtensionVersion: "0.1"
 
   conforme:
-    accessibile: yes
-    interoperabile: yes
-    sicuro: yes
-    privacy: yes
+    lineeGuidaDesign: yes
+    modelloInteroperabilita: yes
+    misureMinimeSicurezza: yes
+    gdpr: yes
+
+  piattaforme:
+    spid: yes
+    cie: yes
+    anpr: yes
+    pagopa: yes
 
   riuso:
     codiceIPA: c_h501
-
-  spid: yes
-  pagopa: yes
-  cie: yes
-  anpr: yes
-  ecosistemi:
-    - scuola
-
-  designKit:
-    seo: no
-    ui: yes
-    web: yes
-    content: no

docs/en/index.rst

@@ -1,18 +1,30 @@
 ``publiccode.yml``
 ==================
 
-``publiccode.yml`` is a metadata standard for repositories containing software developed or acquired by the Public Administration, aimed at making them easily discoverabile and thus reusable by other entities.
-
-By including a ``publiccode.yml`` file in the root of a repository, and populating it with information about the software, technicians and civil servants can evaluate it. Automatic indexing tools can also be built, since the format is easily readable by both humans and machines.
-
-``publiccode.yml`` is mandatory for all public software developed in Italy, according to the national `guidelines <https://docs.italia.it/AgID/linee-guida-riuso-software/lg-acquisizione-e-riuso-software-per-pa-docs/>`__: this enables the Developers Italia crawler to build the national `software catalog <https://developers.italia.it/>`__. The standard is designed to be interoperable internationally, thus the country-specific keys are separated by the core part and are defined in specific sections that each government can rule.
+``publiccode.yml`` is a metadata standard for repositories containing software
+developed or acquired by the Public Administration, aimed at making them easily
+discoverabile and thus reusable by other entities.
+
+By including a ``publiccode.yml`` file in the root of a repository, and
+populating it with information about the software, technicians and civil
+servants can evaluate it. Automatic indexing tools can also be built, since the
+format is easily readable by both humans and machines.
+
+``publiccode.yml`` is mandatory for all public software developed in Italy,
+according to the national `guidelines
+<https://docs.italia.it/AgID/linee-guida-riuso-software/lg-acquisizione-e-riuso-software-per-pa-docs/>`__:
+this enables the Developers Italia crawler to build the national `software
+catalog <https://developers.italia.it/>`__. The standard is designed to be
+interoperable internationally, thus the country-specific keys are separated by
+the core part and are defined in specific sections that each government can
+rule.
 
 Details carried by a ``publiccode.yml`` file include: 
 
 - title and description of the project or product (in one or more languages); 
 - development state (e.g., ``concept``, ``development``, ``beta``, ``stable``, ``obsolete``; 
 - contacts of the entity who published the codebase; 
-- contacts of the maintainer, if any, including the expire date of the maintainance contract; 
+- contacts of the maintainer, if any, including the expire date of the maintenance contract; 
 - information about the legal context for which the project or product was designed; 
 - dependencies.
 
@@ -32,11 +44,10 @@ Table of contents
    :maxdepth: 2
    :numbered:
 
-   intro.rst
-   schema.rst
+   schema.core.rst
+   schema.it.rst
    country.rst
    forks.rst
    categories-list.rst
    scope-list.rst
-   tools.rst
    example.rst

docs/en/schema.core.rst

@@ -244,6 +244,7 @@ Key ``developmentStatus``
    ``obsolete``
 
 The keys are: 
+
 -  ``concept`` - The software is just a “concept”. No
    actual code may have been produced, and the repository could simply be a
    placeholder. 
@@ -616,7 +617,7 @@ Key ``maintenance/contractors``
 '''''''''''''''''''''''''''''''
 
 -  Type: array of Contractor (see below)
--  Presence: mandatory (if ``maintainance/type`` **is** ``contract``)
+-  Presence: mandatory (if ``maintenance/type`` **is** ``contract``)
 
 This key describes the entity or entities, if any, that are currently
 contracted for maintaining the software. They can be companies,
@@ -626,7 +627,7 @@ Key ``maintenance/contacts``
 ''''''''''''''''''''''''''''
 
 -  Type: List of Contacts (see below)
--  Presence: mandatory (if ``maintainance/type`` **is** ``internal`` or ``community``)
+-  Presence: mandatory (if ``maintenance/type`` **is** ``internal`` or ``community``)
 
 One or more contacts maintaining this software.