Skip to content

Commit

Permalink
Merge pull request #141 from bfabio/proposal/yaml1.2
Browse files Browse the repository at this point in the history
docs(standard): specify YAML 1.2 as the file format
  • Loading branch information
bfabio committed May 2, 2022
2 parents a5db66f + 151a7a1 commit 81637a2
Show file tree
Hide file tree
Showing 5 changed files with 26 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/standard/country.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If a software is compliant I will find:
it:
countryExtensionVersion: "1.0"
piattaforme:
- spid: yes
- spid: true
Notice that country-specific keys within international sections
are not allowed. Countries that want to extend the format should add a
Expand Down
2 changes: 1 addition & 1 deletion docs/standard/example/publiccode.minimal.yml
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,6 @@ maintenance:
- name: Francesco Rossi

localisation:
localisationReady: yes
localisationReady: true
availableLanguages:
- en
24 changes: 12 additions & 12 deletions docs/standard/example/publiccode.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ maintenance:
phone: "+3923113215112"

localisation:
localisationReady: yes
localisationReady: true
availableLanguages:
- en
- it
Expand All @@ -100,32 +100,32 @@ dependsOn:
- name: MySQL
versionMin: "1.1"
versionMax: "1.3"
optional: yes
optional: true
- name: PostgreSQL
version: "3.2"
optional: yes
optional: true
proprietary:
- name: Oracle
versionMin: "11.4"
- name: IBM SoftLayer
hardware:
- name: NFC Reader
optional: yes
optional: true

it:
countryExtensionVersion: "0.2"

conforme:
lineeGuidaDesign: yes
modelloInteroperabilita: yes
misureMinimeSicurezza: yes
gdpr: yes
lineeGuidaDesign: true
modelloInteroperabilita: true
misureMinimeSicurezza: true
gdpr: true

piattaforme:
spid: yes
cie: yes
anpr: yes
pagopa: yes
spid: true
cie: true
anpr: true
pagopa: true

riuso:
codiceIPA: c_h501
7 changes: 4 additions & 3 deletions docs/standard/schema.core.rst
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ Key ``localisation/localisationReady``
- Type: boolean
- Presence: mandatory

If ``yes``, the software has infrastructure in place or is otherwise
If ``true``, the software has infrastructure in place or is otherwise
designed to be multilingual. It does not need to be available in more
than one language.

Expand Down Expand Up @@ -737,7 +737,7 @@ compatibility matrix.
- name: PostgreSQL
version: "3.2"
optional: yes
optional: true
This snippet marks an optional dependency on PostgreSQL exactly version
3.2.
Expand Down Expand Up @@ -809,4 +809,5 @@ format though, so not the full ISO8601 is allowed for the date keys.

Encoding
~~~~~~~~
`publiccode.yml` **MUST** be UTF-8 encoded.
`publiccode.yml` **MUST** be a UTF-8 encoded and **SHOULD** be a YAML 1.2 document,
using YAML 1.1 is *deprecated*.
16 changes: 8 additions & 8 deletions docs/standard/schema.it.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Key ``conforme/lineeGuidaDesign``
- Type: boolean
- Presence: optional

If present and set to ``yes``, the software is compliant with the Italian accessibility
If present and set to ``true``, the software is compliant with the Italian accessibility
laws (L. 4/2004), as further explained in the
`linee guida di
design <https://docs.italia.it/italia/designers-italia/design-linee-guida-docs>`__ (Italian language).
Expand All @@ -43,7 +43,7 @@ Key ``conforme/modelloInteroperatibilita``
- Type: boolean
- Presence: optional

If present and set to ``yes``, the software is compliant with the `linee
If present and set to ``true``, the software is compliant with the `linee
guida
sull’interoperabilità <https://docs.italia.it/italia/piano-triennale-ict/lg-modellointeroperabilita-docs>`__.

Expand All @@ -57,7 +57,7 @@ Key ``conforme/misureMinimeSicurezza``
- Type: boolean
- Presence: optional

If present and set to ``yes``, the software is compliant with the `Misure
If present and set to ``true``, the software is compliant with the `Misure
minime di sicurezza ICT per le Pubbliche
amministrazioni <https://www.agid.gov.it/it/sicurezza/misure-minime-sicurezza-ict>`__ (Italian language).

Expand All @@ -68,7 +68,7 @@ Key ``conforme/gdpr``
- Type: boolean
- Presence: optional

If present and set to ``yes``, the software respects the GDPR.
If present and set to ``true``, the software respects the GDPR.


Section ``piattaforme``
Expand All @@ -81,7 +81,7 @@ Key ``piattaforme/spid``
- Presence: optional


If present and set to ``yes``, the software interfaces with `SPID
If present and set to ``true``, the software interfaces with `SPID
- il Sistema Pubblico di Identità
Digitale <https://developers.italia.it/it/spid>`__.

Expand All @@ -91,7 +91,7 @@ Key ``piattaforme/cie``
- Type: boolean
- Presence: optional

If present and set to ``yes``, the software interfaces with the Italian
If present and set to ``true``, the software interfaces with the Italian
electronic ID card (``Carta di Identità Elettronica``).

Key ``piattaforme/anpr``
Expand All @@ -100,15 +100,15 @@ Key ``piattaforme/anpr``
- Type: boolean
- Presence: optional

If present and set to ``yes``, the software interfaces with ANPR.
If present and set to ``true``, the software interfaces with ANPR.

Key ``piattafome/pagopa``
'''''''''''''''''''''''''

- Type: boolean
- Presence: optional

If present and set to ``yes``, the software interfaces with pagoPA.
If present and set to ``true``, the software interfaces with pagoPA.

Section ``riuso``
~~~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 81637a2

Please sign in to comment.