From 62970d637447400048c3f6744f64f64c93514a0c Mon Sep 17 00:00:00 2001 From: Albrecht Degering Date: Mon, 24 Aug 2026 01:15:33 +0200 Subject: [PATCH] docs: complete German structured documentation --- pyproject.toml | 2 +- src/govoplan_datasources/__init__.py | 2 +- .../german_structured_documentation.py | 75 +++++++++++++++++++ src/govoplan_datasources/backend/manifest.py | 10 ++- webui/package.json | 2 +- 5 files changed, 87 insertions(+), 4 deletions(-) create mode 100644 src/govoplan_datasources/backend/german_structured_documentation.py diff --git a/pyproject.toml b/pyproject.toml index 0e2fe78..00f0728 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "govoplan-datasources" -version = "0.1.22" +version = "0.1.23" description = "Governed datasource catalogue, staging, and materialization lifecycle for GovOPlaN." readme = "README.md" requires-python = ">=3.12" diff --git a/src/govoplan_datasources/__init__.py b/src/govoplan_datasources/__init__.py index 2b1b51f..8574e32 100644 --- a/src/govoplan_datasources/__init__.py +++ b/src/govoplan_datasources/__init__.py @@ -1,3 +1,3 @@ """GovOPlaN Datasources module.""" -__version__ = "0.1.22" +__version__ = "0.1.23" diff --git a/src/govoplan_datasources/backend/german_structured_documentation.py b/src/govoplan_datasources/backend/german_structured_documentation.py new file mode 100644 index 0000000..3e88467 --- /dev/null +++ b/src/govoplan_datasources/backend/german_structured_documentation.py @@ -0,0 +1,75 @@ +"""German translations for public structured documentation metadata.""" + +from __future__ import annotations + +from typing import Any + + +GERMAN_STRUCTURED_TRANSLATIONS: dict[str, dict[str, Any]] = {'datasources.approval-and-retention': {'limitations': ['Die Ausführung der Retention ist explizit ' + 'und plangebunden; dieses Modul führt ' + 'keinen versteckten Löschplan aus.', + 'Disponierte ' + 'Materialisierungsaufzeichnungen behalten ' + 'minimierte Schema- und Herkunftsmetadaten ' + 'bei, während ihre Nutzdatenzeilen ' + 'entfernt werden.']}, + 'datasources.quality-gates': {'limitations': ['Referenzregeln verwenden derzeit einen begrenzten ' + 'eingebetteten Wertsatz, anstatt eine andere ' + 'geschützte Datenquelle zu lesen.', + 'Genehmigungen sind modullokale ' + 'Lebenszyklusnachweise; die Installation eines ' + 'separaten Genehmigungsmoduls ändert nicht ' + 'stillschweigend die konfigurierte ' + 'Datenquellenrichtlinie.', + 'Die Aufbewahrung erfolgt nie automatisch: Ein ' + 'Administrator muss eine Vorschau eines aktuellen ' + 'Plans anzeigen und ausdrücklich berechtigte Ziele ' + 'anwenden.', + 'Artefaktbytes bleiben im Besitz ihres ' + 'Payload-Backends; Datasources speichert einen ' + 'unveränderlichen Referenz- und ' + 'Integritätsnachweis.']}, + 'datasources.reference.fields-and-consequences': {'consequence_classes': {'freeze': 'Erstellt ' + 'einen ' + 'gekennzeichneten ' + 'unveränderlichen ' + 'Zustand für ' + 'reproduzierbare ' + 'Verbraucher ' + 'und ' + 'Nachweise.', + 'promote': 'Erstellt ' + 'oder ' + 'aktualisiert ' + 'eine ' + 'geregelte ' + 'Datenquelle ' + 'und fügt ' + 'eine ' + 'unveränderliche ' + 'Materialisierungsrevision ' + 'hinzu.', + 'refresh': 'Leset den ' + 'zwischengespeicherten ' + 'Ursprung ' + 'und fügt ' + 'eine neue ' + 'unveränderliche ' + 'Materialisierungsrevision ' + 'hinzu.', + 'retire': 'Verhindert ' + 'eine neue ' + 'Auswahl, ' + 'während die ' + 'Referenzen ' + 'für die ' + 'Materialisierung ' + 'beibehalten ' + 'werden.'}}, + 'datasources.visibility': {'limitations': ['Zeilenfilter unterstützen deterministische Gleichheit ' + 'oder Mitgliedschaft gegen Hauptansprüche; ' + 'willkürliche Ausdrücke werden nicht ausgeführt.', + 'Live-gefilterte Vorschauen scannen maximal 10.000 ' + 'Ursprungszeilen und legen eine strukturierte ' + 'Einschränkungsdiagnose offen, wenn der Ursprung ' + 'größer ist.']}} diff --git a/src/govoplan_datasources/backend/manifest.py b/src/govoplan_datasources/backend/manifest.py index 8cc74f5..24cde6b 100644 --- a/src/govoplan_datasources/backend/manifest.py +++ b/src/govoplan_datasources/backend/manifest.py @@ -1,5 +1,8 @@ from __future__ import annotations +from govoplan_core.core.modules import with_documentation_structured_translations +from govoplan_datasources.backend.german_structured_documentation import GERMAN_STRUCTURED_TRANSLATIONS + from pathlib import Path from govoplan_core.core.access import ( @@ -65,7 +68,7 @@ from govoplan_datasources.backend.payloads import ExternalArtifactPayloadBackend MODULE_ID = "datasources" MODULE_NAME = "Datasources" -MODULE_VERSION = "0.1.22" +MODULE_VERSION = "0.1.23" DATASOURCE_INTERFACE_VERSION = "0.2.0" ARCHITECTURE = ModuleArchitectureDeclaration( @@ -906,6 +909,11 @@ manifest = ModuleManifest( ) +manifest = with_documentation_structured_translations( + manifest, locale="de", translations=GERMAN_STRUCTURED_TRANSLATIONS +) + + def get_manifest() -> ModuleManifest: return manifest diff --git a/webui/package.json b/webui/package.json index 60b74e1..e2ebebf 100644 --- a/webui/package.json +++ b/webui/package.json @@ -1,6 +1,6 @@ { "name": "@govoplan/datasources-webui", - "version": "0.1.22", + "version": "0.1.23", "private": true, "type": "module", "main": "src/index.ts",