docs: complete public documentation baseline
Module Package Release / publish-packages (push) Successful in 10s

This commit is contained in:
2026-08-22 07:55:20 +02:00
parent 00a85d94c8
commit 8f6cb0a25c
4 changed files with 23 additions and 3 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "@govoplan/transparency", "name": "@govoplan/transparency",
"version": "0.1.18", "version": "0.1.19",
"private": true, "private": true,
"description": "GovOPlaN Transparency platform module seed.", "description": "GovOPlaN Transparency platform module seed.",
"type": "module", "type": "module",
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project] [project]
name = "govoplan-transparency" name = "govoplan-transparency"
version = "0.1.18" version = "0.1.19"
description = "GovOPlaN Transparency platform module seed." description = "GovOPlaN Transparency platform module seed."
readme = "README.md" readme = "README.md"
requires-python = ">=3.12" requires-python = ">=3.12"
+12 -1
View File
@@ -6,7 +6,7 @@ from govoplan_core.core.provider_governance import declared_module_architecture
MODULE_ID = "transparency" MODULE_ID = "transparency"
MODULE_NAME = "Transparency" MODULE_NAME = "Transparency"
MODULE_VERSION = "0.1.18" MODULE_VERSION = "0.1.19"
READ_SCOPE = "transparency:workspace:read" READ_SCOPE = "transparency:workspace:read"
WRITE_SCOPE = "transparency:workspace:write" WRITE_SCOPE = "transparency:workspace:write"
ADMIN_SCOPE = "transparency:workspace:admin" ADMIN_SCOPE = "transparency:workspace:admin"
@@ -68,6 +68,13 @@ DOCUMENTATION = (
layer="available", layer="available",
documentation_types=("admin", "user"), documentation_types=("admin", "user"),
audience=("user", "operator", "module_admin", "product_owner"), audience=("user", "operator", "module_admin", "product_owner"),
translations={
"de": {
"title": "Modulgrenze von Transparency",
"summary": "Transparenz- und Informationsfreiheitsabläufe für Anfragen nach öffentlichen Unterlagen, Veröffentlichungspflichten, Offenlegung, Schwärzung und Transparenzportale.",
"body": "Dieses Repository ist derzeit ein Grundgerüst für ein Plattformmodul. Es registriert die Fachgrenze, Berechtigungsoberfläche, Rollenvorlagen und Dokumentationsmetadaten, bevor Laufzeit-APIs, Datenbankmodelle, Migrationen und WebUI-Routen eingeführt werden.",
}
},
order=100, order=100,
related_modules=OPTIONAL_DEPENDENCIES, related_modules=OPTIONAL_DEPENDENCIES,
links=( links=(
@@ -78,7 +85,11 @@ DOCUMENTATION = (
), ),
), ),
metadata={ metadata={
"kind": "reference",
"seed": True, "seed": True,
"consequence_classes": {
"seed_boundary": "Declares ownership and permissions only; no runtime workflow is available yet.",
},
"domain_objects": ['FOI and public-records requests', 'publication duties', 'disclosure workflow state', 'redaction review records', 'transparency portal handoff'], "domain_objects": ['FOI and public-records requests', 'publication duties', 'disclosure workflow state', 'redaction review records', 'transparency portal handoff'],
"first_slice": "Define transparency request, disclosure review, redaction task, publication duty, and portal publication records.", "first_slice": "Define transparency request, disclosure review, redaction task, publication duty, and portal publication records.",
}, },
+9
View File
@@ -15,6 +15,15 @@ class ManifestSeedTests(unittest.TestCase):
self.assertEqual({permission.scope for permission in manifest.permissions}, {READ_SCOPE, WRITE_SCOPE, ADMIN_SCOPE}) self.assertEqual({permission.scope for permission in manifest.permissions}, {READ_SCOPE, WRITE_SCOPE, ADMIN_SCOPE})
self.assertEqual({role.slug for role in manifest.role_templates}, {"transparency_manager", "transparency_viewer"}) self.assertEqual({role.slug for role in manifest.role_templates}, {"transparency_manager", "transparency_viewer"})
self.assertTrue(manifest.documentation) self.assertTrue(manifest.documentation)
topic = manifest.documentation[0]
self.assertEqual("reference", topic.metadata["kind"])
self.assertIn("seed_boundary", topic.metadata["consequence_classes"])
self.assertTrue(
all(
topic.translations.get("de", {}).get(field)
for field in ("title", "summary", "body")
)
)
self.assertIsNone(manifest.route_factory) self.assertIsNone(manifest.route_factory)
self.assertIsNone(manifest.migration_spec) self.assertIsNone(manifest.migration_spec)
self.assertIsNone(manifest.frontend) self.assertIsNone(manifest.frontend)