Skip to content

Commit 151a7a1

Browse files
committed
docs(standard): specify YAML 1.2 as the file format
1 parent 2d1f1d7 commit 151a7a1

5 files changed

Lines changed: 26 additions & 25 deletions

File tree

docs/standard/country.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ If a software is compliant I will find:
2222
it:
2323
countryExtensionVersion: "1.0"
2424
piattaforme:
25-
- spid: yes
25+
- spid: true
2626
2727
Notice that country-specific keys within international sections
2828
are not allowed. Countries that want to extend the format should add a

docs/standard/example/publiccode.minimal.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,6 @@ maintenance:
4141
- name: Francesco Rossi
4242

4343
localisation:
44-
localisationReady: yes
44+
localisationReady: true
4545
availableLanguages:
4646
- en

docs/standard/example/publiccode.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ maintenance:
9595
phone: "+3923113215112"
9696

9797
localisation:
98-
localisationReady: yes
98+
localisationReady: true
9999
availableLanguages:
100100
- en
101101
- it
@@ -107,32 +107,32 @@ dependsOn:
107107
- name: MySQL
108108
versionMin: "1.1"
109109
versionMax: "1.3"
110-
optional: yes
110+
optional: true
111111
- name: PostgreSQL
112112
version: "3.2"
113-
optional: yes
113+
optional: true
114114
proprietary:
115115
- name: Oracle
116116
versionMin: "11.4"
117117
- name: IBM SoftLayer
118118
hardware:
119119
- name: NFC Reader
120-
optional: yes
120+
optional: true
121121

122122
it:
123123
countryExtensionVersion: "0.2"
124124

125125
conforme:
126-
lineeGuidaDesign: yes
127-
modelloInteroperabilita: yes
128-
misureMinimeSicurezza: yes
129-
gdpr: yes
126+
lineeGuidaDesign: true
127+
modelloInteroperabilita: true
128+
misureMinimeSicurezza: true
129+
gdpr: true
130130

131131
piattaforme:
132-
spid: yes
133-
cie: yes
134-
anpr: yes
135-
pagopa: yes
132+
spid: true
133+
cie: true
134+
anpr: true
135+
pagopa: true
136136

137137
riuso:
138138
codiceIPA: c_h501

docs/standard/schema.core.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -654,7 +654,7 @@ Key ``localisation/localisationReady``
654654
- Type: boolean
655655
- Presence: mandatory
656656

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

@@ -738,7 +738,7 @@ compatibility matrix.
738738
739739
- name: PostgreSQL
740740
version: "3.2"
741-
optional: yes
741+
optional: true
742742
743743
This snippet marks an optional dependency on PostgreSQL exactly version
744744
3.2.
@@ -810,4 +810,5 @@ format though, so not the full ISO8601 is allowed for the date keys.
810810

811811
Encoding
812812
~~~~~~~~
813-
`publiccode.yml` **MUST** be UTF-8 encoded.
813+
`publiccode.yml` **MUST** be a UTF-8 encoded and **SHOULD** be a YAML 1.2 document,
814+
using YAML 1.1 is *deprecated*.

docs/standard/schema.it.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Key ``conforme/lineeGuidaDesign``
3232
- Type: boolean
3333
- Presence: optional
3434

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

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

@@ -57,7 +57,7 @@ Key ``conforme/misureMinimeSicurezza``
5757
- Type: boolean
5858
- Presence: optional
5959

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

@@ -68,7 +68,7 @@ Key ``conforme/gdpr``
6868
- Type: boolean
6969
- Presence: optional
7070

71-
If present and set to ``yes``, the software respects the GDPR.
71+
If present and set to ``true``, the software respects the GDPR.
7272

7373

7474
Section ``piattaforme``
@@ -81,7 +81,7 @@ Key ``piattaforme/spid``
8181
- Presence: optional
8282

8383

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

@@ -91,7 +91,7 @@ Key ``piattaforme/cie``
9191
- Type: boolean
9292
- Presence: optional
9393

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

9797
Key ``piattaforme/anpr``
@@ -100,15 +100,15 @@ Key ``piattaforme/anpr``
100100
- Type: boolean
101101
- Presence: optional
102102

103-
If present and set to ``yes``, the software interfaces with ANPR.
103+
If present and set to ``true``, the software interfaces with ANPR.
104104

105105
Key ``piattafome/pagopa``
106106
'''''''''''''''''''''''''
107107

108108
- Type: boolean
109109
- Presence: optional
110110

111-
If present and set to ``yes``, the software interfaces with pagoPA.
111+
If present and set to ``true``, the software interfaces with pagoPA.
112112

113113
Section ``riuso``
114114
~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)