-
Notifications
You must be signed in to change notification settings - Fork 37
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
German translation of documentation and minor fixes of German extensi…
…on (#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 <[email protected]> Co-authored-by: DSieberath <[email protected]> Co-authored-by: NKuhlmann <[email protected]> Co-authored-by: UDierkes <[email protected]>
- Loading branch information
1 parent
609c053
commit ccfeeac
Showing
9 changed files
with
1,451 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,166 @@ | ||
Beispiel | ||
============== | ||
|
||
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. | ||
|
||
|
||
Minimal-Konfiguration | ||
~~~~~~~~~~~~~~~~~~~~~ | ||
.. code:: yaml | ||
publiccodeYmlVersion: "0.2" | ||
name: Medusaurl: "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 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. | ||
features: | ||
- Just one feature | ||
legal: | ||
license: AGPL-3.0-or-later | ||
maintenance: | ||
type: "community" | ||
contacts: | ||
- name: Francesco Rossi | ||
localisation: | ||
localisationReady: yes | ||
availableLanguages: | ||
- en | ||
Ausführlichere Version | ||
~~~~~~~~~~~~~~~~~~~~~~~ | ||
.. code:: yaml | ||
publiccodeYmlVersion: "0.2" | ||
name: Medusaapplication | ||
Suite: 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 | ||
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 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 | ||
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: "[email protected]" | ||
website: "https://privatecompany.com" | ||
until: "2019-01-01" | ||
contacts: | ||
- name: Francesco Rossi | ||
email: "[email protected]" | ||
affiliation: Comune di Reggio Emilia | ||
phone: "+3923113215112" | ||
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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
# Der publiccode.yml Standard | ||
|
||
Ein Metadaten-Deskriptions-Standard für öffentliche Software. | ||
|
||
|
||
>Dokumentation auf Deutsch | ||
>Read documentation in [English](https://docs.italia.it/italia/developers-italia/publiccodeyml-en/en/master/) | ||
>Leggi la documentazione in [italiano](https://docs.italia.it/italia/developers-italia/publiccodeyml/it/master/) | ||
--- | ||
|
||
|
||
## Inhalt | ||
|
||
- [Beschreibung](#beschreibung) | ||
- [Funktion der Datei](#Funktion-der-Datei) | ||
- [Dokumentation](#Dokumentation) | ||
- [Projekte Finden](#Projekte-Finden) | ||
- [Branches](#Branches) | ||
- [Mitwirken](#Mitwirken) | ||
- [Autoren](#Autoren) | ||
- [Lizensierung](#Lizensierung) | ||
|
||
|
||
## Beschreibung | ||
|
||
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. | ||
|
||
|
||
## Funktion der Datei | ||
|
||
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. | ||
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: | ||
|
||
* Den Titel und die Beschreibung des Projekts oder Produkts auf Englisch und/oder anderen Sprachen; | ||
|
||
* Den Entwicklungsstatus, z. B. Konzept, In Entwicklung, Beta, Stabil, Veraltet; | ||
|
||
* Wer sich um die Wartung kümmert und bis wann; | ||
|
||
* Wer Ansprechpartner für technische oder Support-Anfragen ist; | ||
|
||
* Für welchen nationalen und lokalen Rechtsrahmen das Projekt oder Produkt konzipiert ist; | ||
|
||
* welche Software-Abhängigkeiten dieses Projekt oder Produkt hat. | ||
|
||
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. | ||
|
||
|
||
## Dokumentation | ||
|
||
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. | ||
|
||
|
||
## Projekte Finden | ||
|
||
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. | ||
|
||
GitHub Search filename:publiccode.yml path:/ | ||
|
||
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. | ||
|
||
|
||
## Branches | ||
|
||
Neuester Release: | ||
|
||
Alle Versionen https://github.com/italia/publiccode.yml/releases | ||
|
||
Das Projekt folgt der Sematischen Versionierung. Mehr Informationen finden Sie unter [SemVer.org](https://semver.org/). | ||
|
||
Außerdem nutzt das Projekt Branches und Tags folgendermaßen: | ||
|
||
* Der Master-Branch enthält die aktuelle stabile Version des Standards. | ||
|
||
* Der Entwicklungs-Branch enthält die vorgeschlagenen Verbesserungen für die nächste Version. | ||
|
||
* Die Release-Seite auf GitHub enthält alle veröffentlichten Versionen des Standards. Aus Gründen der Einheitlichkeit folgen Releases der Tag-Version. | ||
|
||
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: | ||
|
||
core-x.y.z;cc-a.b.c | ||
|
||
Dabei steht cc für den Ländercode, der im countryExtensionVersion key definiert wird. | ||
|
||
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. | ||
|
||
Beispiele für dieses Versionsierungsschema sind: | ||
|
||
core:0.2;it:0.4 | ||
|
||
core:0.2;fr:1.1 | ||
|
||
|
||
|
||
## Mitwirken | ||
|
||
[Sie sind herzlich eingeladen Pull Requests oder Issues einzureichen](https://github.com/italia/publiccode.yml/blob/master/CONTRIBUTING.md). | ||
|
||
|
||
## Autoren | ||
|
||
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. | ||
|
||
|
||
## Lizensierung | ||
|
||
Lizensiert unter [CC-0](https://github.com/italia/publiccode.yml/blob/master/LICENSE). |
Oops, something went wrong.