Skip to content

Commit

Permalink
Update and fix the examples
Browse files Browse the repository at this point in the history
  • Loading branch information
bfabio committed Jul 20, 2024
1 parent 65937b1 commit 9617d2c
Show file tree
Hide file tree
Showing 7 changed files with 130 additions and 133 deletions.
162 changes: 92 additions & 70 deletions docs/de/Example.de.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,64 +8,82 @@ Minimal-Konfiguration
~~~~~~~~~~~~~~~~~~~~~
.. code:: yaml
publiccodeYmlVersion: "0.2"
name: Medusaurl: "https://example.com/italia/medusa.git"softwareVersion: "dev" # Optional releaseDate: "2017-04-15"
publiccodeYmlVersion: "0.4"
name: Medusa
url: "https://example.com/italia/medusa.git"
platforms:
- web
categories:
- financial-reporting
developmentStatus: development
softwareType: "standalone/desktop"
description:
en:
localisedName: medusa # Optional
genericName: Text Editor
shortDescription: > A rather short description of the software
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.
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
features:
- Just one feature
legal:
license: AGPL-3.0-or-later
license: AGPL-3.0-or-later
maintenance:
type: "community"
type: "community"
contacts:
- name: Francesco Rossi
contacts:
- name: Francesco Rossi
localisation:
localisationReady: yes
availableLanguages:
- en
localisationReady: true
availableLanguages:
- en
Ausführlichere Version
~~~~~~~~~~~~~~~~~~~~~~~
.. code:: yaml
publiccodeYmlVersion: "0.2"
name: Medusaapplication
Suite: MegaProductivitySuite
publiccodeYmlVersion: "0.4"
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.svgmonochromeLogo: img/logo-mono.svg
inputTypes:
- text/plainoutputTypes:
- text/plain
logo: img/logo.svg
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
Expand All @@ -74,41 +92,45 @@ Ausführlichere Version
- de
unsupportedCountries:
- us
description:
en:
localisedName: Medusa
genericName: Text Editor
shortDescription: > This description can have a maximum of 150 characters.
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
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.
It can also contain some basic Markdown.
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"
type: "contract"
contractors:
- name: "Fornitore Privato SPA"
Expand All @@ -121,46 +143,46 @@ Ausführlichere Version
email: "[email protected]"
affiliation: Comune di Reggio Emilia
phone: "+3923113215112"
localisation:
localisationReady: yes
localisationReady: true
availableLanguages:
- en
- it
- fr
- de
dependsOn:
open:
- name: MySQL
versionMin: "1.1"
versionMin: "1.1"
versionMax: "1.3"
optional: yes
- name: PostgreSQL
optional: true
- name: PostgreSQL
version: "3.2"
optional: yes
proprietary:
optional: true
proprietary:
- name: Oracle
versionMin: "11.4"
versionMin: "11.4"
- name: IBM SoftLayer
hardware:
- name: NFC Reader
optional: yes
optional: true
it:
countryExtensionVersion: "0.2"
countryExtensionVersion: "1.0"
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
8 changes: 2 additions & 6 deletions docs/fr/example/publiccode.minimal.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
publiccodeYmlVersion: "0.2"
publiccodeYmlVersion: "0.4"

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

Expand All @@ -16,8 +14,6 @@ softwareType: "standalone/desktop"

description:
en:
localisedName: medusa # Optional
genericName: Text Editor
shortDescription: >
A rather short description which
is probably useless
Expand All @@ -41,6 +37,6 @@ maintenance:
- name: Francesco Rossi

localisation:
localisationReady: yes
localisationReady: true
availableLanguages:
- en
37 changes: 15 additions & 22 deletions docs/fr/example/publiccode.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
publiccodeYmlVersion: "0.2"
publiccodeYmlVersion: "0.4"

name: Medusa
applicationSuite: MegaProductivitySuite
Expand All @@ -8,12 +8,6 @@ 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
Expand Down Expand Up @@ -45,7 +39,6 @@ intendedAudience:
description:
en:
localisedName: Medusa
genericName: Text Editor
shortDescription: >
This description can have a maximum 150
characters long. We should not fill the
Expand All @@ -55,6 +48,7 @@ description:
Very long description of this software, also split
on multiple rows. You should note what the software
is and why one should need it.
It can also contain some basic Markdown.
documentation: "https://read.the.documentation/medusa/v1.0"
apiDocumentation: "https://read.the.api.doc/medusa/v1.0"
Expand All @@ -77,7 +71,6 @@ legal:
license: AGPL-3.0-or-later
mainCopyrightOwner: City of Chicago
repoOwner: City of Chicago
authorsFile: AUTHORS

maintenance:
type: "contract"
Expand All @@ -95,7 +88,7 @@ maintenance:
phone: "+3923113215112"

localisation:
localisationReady: yes
localisationReady: true
availableLanguages:
- en
- it
Expand All @@ -107,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"
countryExtensionVersion: "1.0"

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
8 changes: 2 additions & 6 deletions docs/it/example/publiccode.minimal.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
publiccodeYmlVersion: "0.2"
publiccodeYmlVersion: "0.4"

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

Expand All @@ -16,8 +14,6 @@ softwareType: "standalone/desktop"

description:
en:
localisedName: medusa # Optional
genericName: Text Editor
shortDescription: >
A rather short description which
is probably useless
Expand All @@ -41,6 +37,6 @@ maintenance:
- name: Francesco Rossi

localisation:
localisationReady: yes
localisationReady: true
availableLanguages:
- en
Loading

0 comments on commit 9617d2c

Please sign in to comment.