Skip to content

Commit ccfeeac

Browse files
cknebelMarkus-HildebrandtDSieberathNKuhlmannUDierkes
authored
German translation of documentation and minor fixes of German extension (#93)
* initial version of the german extension (only in german) * Create Readme.de.md Deutsche Übersetzung der englischen Readme-Datei * Create index.de.rst Deutsche Übersetzung der englischen index.rst-Datei * Create forks.de.rst * Create schema.core.de.rst Deutsche Übersetzung der englischen schema.core.rst-Datei * Update forks.de.rst * Kleine Korrekturen zu Schlüssel/Feld und Kardinalität Die "leika-id" war als Schlüssel bezeichnet, ist aber ein Feld. Außerdem wurde die "leika-id" statt optional als "mandatoy" gesetzt. * Update schema.de.rst Kleine Textkorrekturen zur besseren Verständlichkeit; entfernung doppelter Wörter * Create Example.de.rst (#10) * Create country.de.rst (#11) * Create categories-list.de.rst (#8) Deutsche Übersetzung der englischen categories-list.rst * Create scope-list.de.rst (#9) Deutsche Übersetzung der englischen scope-lsit.rst-Datei Co-authored-by: Hildebrandt, Markus <markus.hildebrandt@esh.essen.de> Co-authored-by: DSieberath <82883529+DSieberath@users.noreply.github.com> Co-authored-by: NKuhlmann <83298660+NKuhlmann@users.noreply.github.com> Co-authored-by: UDierkes <84079178+UDierkes@users.noreply.github.com>
1 parent 609c053 commit ccfeeac

9 files changed

Lines changed: 1451 additions & 7 deletions

‎Example.de.rst‎

Lines changed: 166 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,166 @@
1+
Beispiel
2+
==============
3+
4+
Unten folgen zwei Beispiele von publiccode.yml-Dateien. Das erste zeigt die Minimal-Konfiguration, die nur die zwingend erforderlichen Felder enthält, das zweite eine ausführlichere Version.
5+
6+
7+
Minimal-Konfiguration
8+
~~~~~~~~~~~~~~~~~~~~~
9+
.. code:: yaml
10+
11+
publiccodeYmlVersion: "0.2"
12+
name: Medusaurl: "https://example.com/italia/medusa.git"softwareVersion: "dev" # Optional releaseDate: "2017-04-15"
13+
platforms:
14+
- web
15+
categories:
16+
- financial-reporting
17+
developmentStatus: development
18+
softwareType: "standalone/desktop"
19+
description:
20+
en:
21+
localisedName: medusa # Optional
22+
genericName: Text Editor
23+
shortDescription: > A rather short description of the software
24+
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.
25+
26+
features:
27+
- Just one feature
28+
legal:
29+
license: AGPL-3.0-or-later
30+
maintenance:
31+
type: "community"
32+
33+
contacts:
34+
- name: Francesco Rossi
35+
localisation:
36+
localisationReady: yes
37+
availableLanguages:
38+
- en
39+
40+
41+
Ausführlichere Version
42+
~~~~~~~~~~~~~~~~~~~~~~~
43+
.. code:: yaml
44+
45+
publiccodeYmlVersion: "0.2"
46+
name: Medusaapplication
47+
Suite: MegaProductivitySuite
48+
url: "https://example.com/italia/medusa.git"
49+
landingURL: "https://example.com/italia/medusa"
50+
isBasedOn: "https://github.com/italia/otello.git"
51+
softwareVersion: "1.0"
52+
releaseDate: "2017-04-15"
53+
logo: img/logo.svgmonochromeLogo: img/logo-mono.svg
54+
inputTypes:
55+
- text/plainoutputTypes:
56+
- text/plain
57+
platforms:
58+
- android
59+
- ios
60+
categories:
61+
- content-management
62+
- office
63+
usedBy:
64+
- Comune di Firenze
65+
- Comune di Roma
66+
roadmap: "https://example.com/italia/medusa/roadmap"
67+
developmentStatus: development
68+
softwareType: "standalone/desktop"
69+
intendedAudience:
70+
scope:
71+
- science-and-technology
72+
countries:
73+
- it
74+
- de
75+
unsupportedCountries:
76+
- us
77+
78+
description:
79+
en:
80+
localisedName: Medusa
81+
genericName: Text Editor
82+
shortDescription: > This description can have a maximum of 150 characters.
83+
84+
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.
85+
86+
documentation: "https://read.the.documentation/medusa/v1.0"
87+
apiDocumentation: "https://read.the.api.doc/medusa/v1.0"
88+
89+
features:
90+
- Very important feature
91+
- Will run without a problem
92+
- Has zero bugs
93+
- Solves all the problems of the world
94+
screenshots:
95+
- img/sshot1.jpg
96+
- img/sshot2.jpg
97+
- img/sshot3.jpg
98+
videos:
99+
- https://youtube.com/xxxxxxxx
100+
awards:
101+
- 1st Price Software of the year
102+
103+
legal:
104+
license: AGPL-3.0-or-later
105+
mainCopyrightOwner: City of Chicago
106+
repoOwner: City of Chicago
107+
108+
authorsFile: AUTHORS
109+
110+
maintenance:
111+
type: "contract"
112+
113+
contractors:
114+
- name: "Fornitore Privato SPA"
115+
email: "dario.bianchi@fornitore.it"
116+
website: "https://privatecompany.com"
117+
until: "2019-01-01"
118+
119+
contacts:
120+
- name: Francesco Rossi
121+
email: "francesco.rossi@comune.reggioemilia.it"
122+
affiliation: Comune di Reggio Emilia
123+
phone: "+3923113215112"
124+
125+
localisation:
126+
localisationReady: yes
127+
availableLanguages:
128+
- en
129+
- it
130+
- fr
131+
- de
132+
133+
dependsOn:
134+
open:
135+
- name: MySQL
136+
versionMin: "1.1"
137+
versionMax: "1.3"
138+
optional: yes
139+
- name: PostgreSQL
140+
version: "3.2"
141+
optional: yes
142+
proprietary:
143+
- name: Oracle
144+
versionMin: "11.4"
145+
- name: IBM SoftLayer
146+
hardware:
147+
- name: NFC Reader
148+
optional: yes
149+
150+
it:
151+
countryExtensionVersion: "0.2"
152+
153+
conforme:
154+
lineeGuidaDesign: yes
155+
modelloInteroperabilita: yes
156+
misureMinimeSicurezza: yes
157+
gdpr: yes
158+
159+
piattaforme:
160+
spid: yes
161+
cie: yes
162+
anpr: yes
163+
pagopa: yes
164+
165+
riuso:
166+
codiceIPA: c_h501

‎Readme.de.md‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
# Der publiccode.yml Standard
2+
3+
Ein Metadaten-Deskriptions-Standard für öffentliche Software.
4+
5+
6+
>Dokumentation auf Deutsch
7+
8+
>Read documentation in [English](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/)
9+
10+
>Leggi la documentazione in [italiano](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/)
11+
12+
---
13+
14+
15+
## Inhalt
16+
17+
- [Beschreibung](#beschreibung)
18+
- [Funktion der Datei](#Funktion-der-Datei)
19+
- [Dokumentation](#Dokumentation)
20+
- [Projekte Finden](#Projekte-Finden)
21+
- [Branches](#Branches)
22+
- [Mitwirken](#Mitwirken)
23+
- [Autoren](#Autoren)
24+
- [Lizensierung](#Lizensierung)
25+
26+
27+
## Beschreibung
28+
29+
Ein Metadaten-Deskriptions-Standard für öffentliche Software und Repositories, der sowohl für Entwickler als auch für Personen mit weniger technischem Hintergrund einfach zu verwenden ist, um von öffentlichen Verwaltungen und öffentlichen Organisationen entwickelte Software leicht auffindbar zu machen.
30+
31+
32+
## Funktion der Datei
33+
34+
Viele gute Software-Projekte werden von und für die öffentliche Verwaltung entwicklt, allerdings ist die Nachnutzung dieser Projekte meist sehr begrenzt. Einige der Gründe dafür sind die geringe Auffindbarkeit und die Schwierigkeit festzustellen, welche Projekte tatsächlich innerhalb der Gegebenheiten anderer Verwaltungen funktionieren.
35+
Die Publiccode.yml-Datei soll diese Probleme lösen. Daher handelt es sich um eine Datei, die sowohl für Mitarbeitende der Verwaltung, die herausfinden möchten, ob sie ein Projekt nachnutzen können, leicht lesbar ist als auch für Computer. Es enthält Informationen, wie:
36+
37+
* Den Titel und die Beschreibung des Projekts oder Produkts auf Englisch und/oder anderen Sprachen;
38+
39+
* Den Entwicklungsstatus, z. B. Konzept, In Entwicklung, Beta, Stabil, Veraltet;
40+
41+
* Wer sich um die Wartung kümmert und bis wann;
42+
43+
* Wer Ansprechpartner für technische oder Support-Anfragen ist;
44+
45+
* Für welchen nationalen und lokalen Rechtsrahmen das Projekt oder Produkt konzipiert ist;
46+
47+
* welche Software-Abhängigkeiten dieses Projekt oder Produkt hat.
48+
49+
Das Dateiformat Publiccode.yml soll sowohl einfach zu jedem neuen Projekt hinzugefügt werden können, als auch mit dem Projekt mitwachsen, wenn es über den ursprünglichen Rahmen, in dem es entwickelt wurde, hinaus expandiert.
50+
51+
52+
## Dokumentation
53+
54+
Dieses Repository ist strukturiert, um mit der Docs-Italia-Plattform kompatibel zu sein. Daher wird der Inhalt der relevanten Ordner innerhalb dieser Plattform kompliliert und gerendert. Die Docs-Italia-Plattform greift auf das GitHub-Repository des Dokuments zurück, um mit verschiedenen Releases und lokalisierten Versionen umgehen zu können. Die Plattform kann als die standardmäßige Landing-Page des Projekts angesehen werden.
55+
56+
57+
## Projekte Finden
58+
59+
Das Finden von Projekten hängt von der Struktur der Such-API der jeweiligen Hosting-Plattform ab. Zum Beispiel findet man alle Publiccode.yml-Dateien in GitHub-Dateien über eine Suche über das Frontend oder die API.
60+
61+
GitHub Search filename:publiccode.yml path:/
62+
63+
Das Italienische "Digital Transformation Team" arbeitet auch daran einen Scanner zur Verfügung zu stellen, der nach alle Publiccode.yml-Dateien auf allen öffentlich zugänglichen Webseiten sucht und sie als offene Daten bereitstellt.
64+
65+
66+
## Branches
67+
68+
Neuester Release:
69+
70+
Alle Versionen https://github.com/italia/publiccode.yml/releases
71+
72+
Das Projekt folgt der Sematischen Versionierung. Mehr Informationen finden Sie unter [SemVer.org](https://semver.org/).
73+
74+
Außerdem nutzt das Projekt Branches und Tags folgendermaßen:
75+
76+
* Der Master-Branch enthält die aktuelle stabile Version des Standards.
77+
78+
* Der Entwicklungs-Branch enthält die vorgeschlagenen Verbesserungen für die nächste Version.
79+
80+
* Die Release-Seite auf GitHub enthält alle veröffentlichten Versionen des Standards. Aus Gründen der Einheitlichkeit folgen Releases der Tag-Version.
81+
82+
Da das Repository jedoch sowohl das Kernschema als auch die länderspezifischen Schemata enthält, ist es notwendig, die Versionierung weiter zu verfeinern. Daher wird jede Aktualisierung am Kern und/oder an einer länderspezifischen Erweiterung mit folgenden Tags gekennzeichnet:
83+
84+
core-x.y.z;cc-a.b.c
85+
86+
Dabei steht cc für den Ländercode, der im countryExtensionVersion key definiert wird.
87+
88+
Dieses Versionierungsschema ist grundlegend für das Projekt, da die Publiccode.yml-Datei Verweise auf den Kern-Release im publiccodeYmlVersion key enthält und jedes länderspezifische Schema einen version key enthält.
89+
90+
Beispiele für dieses Versionsierungsschema sind:
91+
92+
core:0.2;it:0.4
93+
94+
core:0.2;fr:1.1
95+
96+
97+
98+
## Mitwirken
99+
100+
[Sie sind herzlich eingeladen Pull Requests oder Issues einzureichen](https://github.com/italia/publiccode.yml/blob/master/CONTRIBUTING.md).
101+
102+
103+
## Autoren
104+
105+
Die Publiccode.yml-Spezifikationen werdem vom [Italian Digital Transformation Team](https://teamdigitale.governo.it/) und von den [Autoren](https://github.com/italia/publiccode.yml/blob/master/AUTHORS.md) entwickelt.
106+
107+
108+
## Lizensierung
109+
110+
Lizensiert unter [CC-0](https://github.com/italia/publiccode.yml/blob/master/LICENSE).

0 commit comments

Comments
 (0)