Docs Italia beta

Public documents, made digital.

6. Esempi

Below there are two examples of publiccode.yml files, the first one represents the minimum configuration, which contains the mandatory fields, whilst the second one represents a more extended version.

6.1. Minimum Version

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
publiccodeYmlVersion: "0.2"

name: Medusa
url: "https://example.com/italia/medusa.git"
softwareVersion: "dev"    # Optional
releaseDate: "2017-04-15"
platforms:
  - web

categories:
  - financial-reporting

developmentStatus: development

softwareType: "standalone/desktop"

description:
  en:
    localisedName: medusa   # Optional
    genericName: Text Editor
    shortDescription: >
          A rather short description which
          is probably useless

    longDescription: >
          Very long description of this software, also split
          on multiple rows. You should note what the software
          is and why one should need it. We can potentially
          have many pages of text here.

    features:
       - Just one feature

legal:
  license: AGPL-3.0-or-later

maintenance:
  type: "community"

  contacts:
    - name: Francesco Rossi

localisation:
  localisationReady: yes
  availableLanguages:
    - en

6.2. Extended Version

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
publiccodeYmlVersion: "0.2"

name: Medusa
applicationSuite: MegaProductivitySuite
url: "https://example.com/italia/medusa.git"
landingURL: "https://example.com/italia/medusa"
isBasedOn: "https://github.com/italia/otello.git"
softwareVersion: "1.0"
releaseDate: "2017-04-15"
logo: img/logo.svg
monochromeLogo: img/logo-mono.svg

inputTypes:
  - text/plain
outputTypes:
  - text/plain

platforms:
  - android
  - ios

categories:
  - content-management
  - office

usedBy:
  - Comune di Firenze
  - Comune di Roma

roadmap: "https://example.com/italia/medusa/roadmap"

developmentStatus: development

softwareType: "standalone/desktop"

intendedAudience:
  scope:
    - science-and-technology
  countries:
    - it
    - de
  unsupportedCountries:
    - us

description:
  en:
    localisedName: Medusa
    genericName: Text Editor
    shortDescription: >
          This description can have a maximum 150
          characters long. We should not fill the
          remaining space with "Lorem Ipsum". End

    longDescription: >
          Very long description of this software, also split
          on multiple rows. You should note what the software
          is and why one should need it.

    documentation: "https://read.the.documentation/medusa/v1.0"
    apiDocumentation: "https://read.the.api.doc/medusa/v1.0"

    features:
       - Very important feature
       - Will run without a problem
       - Has zero bugs
       - Solves all the problems of the world
    screenshots:
       - img/sshot1.jpg
       - img/sshot2.jpg
       - img/sshot3.jpg
    videos:
       - https://youtube.com/xxxxxxxx
    awards:
       - 1st Price Software of the year

legal:
  license: AGPL-3.0-or-later
  mainCopyrightOwner: City of Chicago
  repoOwner: City of Chicago
  authorsFile: AUTHORS

maintenance:
  type: "contract"

  contractors:
    - name: "Fornitore Privato SPA"
      email: "dario.bianchi@fornitore.it"
      website: "https://privatecompany.com"
      until: "2019-01-01"

  contacts:
    - name: Francesco Rossi
      email: "francesco.rossi@comune.reggioemilia.it"
      affiliation: Comune di Reggio Emilia
      phone: +39 231 13215112

localisation:
  localisationReady: yes
  availableLanguages:
    - en
    - it
    - fr
    - de

dependsOn:
  open:
    - name: MySQL
      versionMin: "1.1"
      versionMax: "1.3"
      optional: yes
    - name: PostgreSQL
      version: "3.2"
      optional: yes
  proprietary:
    - name: Oracle
      versionMin: "11.4"
    - name: IBM SoftLayer
  hardware:
    - name: NFC Reader
      optional: yes

it:
  countryExtensionVersion: "0.2"

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

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

  riuso:
    codiceIPA: c_h501