Skip to content

Commit 81637a2

Browse files
authored
Merge pull request #141 from bfabio/proposal/yaml1.2
docs(standard): specify YAML 1.2 as the file format
2 parents a5db66f + 151a7a1 commit 81637a2

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
@@ -40,6 +40,6 @@ maintenance:
4040
- name: Francesco Rossi
4141

4242
localisation:
43-
localisationReady: yes
43+
localisationReady: true
4444
availableLanguages:
4545
- en

docs/standard/example/publiccode.yml

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ maintenance:
8888
phone: "+3923113215112"
8989

9090
localisation:
91-
localisationReady: yes
91+
localisationReady: true
9292
availableLanguages:
9393
- en
9494
- it
@@ -100,32 +100,32 @@ dependsOn:
100100
- name: MySQL
101101
versionMin: "1.1"
102102
versionMax: "1.3"
103-
optional: yes
103+
optional: true
104104
- name: PostgreSQL
105105
version: "3.2"
106-
optional: yes
106+
optional: true
107107
proprietary:
108108
- name: Oracle
109109
versionMin: "11.4"
110110
- name: IBM SoftLayer
111111
hardware:
112112
- name: NFC Reader
113-
optional: yes
113+
optional: true
114114

115115
it:
116116
countryExtensionVersion: "0.2"
117117

118118
conforme:
119-
lineeGuidaDesign: yes
120-
modelloInteroperabilita: yes
121-
misureMinimeSicurezza: yes
122-
gdpr: yes
119+
lineeGuidaDesign: true
120+
modelloInteroperabilita: true
121+
misureMinimeSicurezza: true
122+
gdpr: true
123123

124124
piattaforme:
125-
spid: yes
126-
cie: yes
127-
anpr: yes
128-
pagopa: yes
125+
spid: true
126+
cie: true
127+
anpr: true
128+
pagopa: true
129129

130130
riuso:
131131
codiceIPA: c_h501

docs/standard/schema.core.rst

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

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

@@ -737,7 +737,7 @@ compatibility matrix.
737737
738738
- name: PostgreSQL
739739
version: "3.2"
740-
optional: yes
740+
optional: true
741741
742742
This snippet marks an optional dependency on PostgreSQL exactly version
743743
3.2.
@@ -809,4 +809,5 @@ format though, so not the full ISO8601 is allowed for the date keys.
809809

810810
Encoding
811811
~~~~~~~~
812-
`publiccode.yml` **MUST** be UTF-8 encoded.
812+
`publiccode.yml` **MUST** be a UTF-8 encoded and **SHOULD** be a YAML 1.2 document,
813+
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)