From a8f6e972bf307ee09f70ee2f530c9a74267a40e0 Mon Sep 17 00:00:00 2001 From: Albrecht Degering Date: Sat, 22 Aug 2026 07:55:19 +0200 Subject: [PATCH] docs: complete public documentation baseline --- package.json | 2 +- pyproject.toml | 2 +- src/govoplan_learning/backend/manifest.py | 13 ++++++++++++- tests/test_manifest.py | 9 +++++++++ 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index cc72914..cec2bb1 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@govoplan/learning", - "version": "0.1.18", + "version": "0.1.19", "private": true, "description": "GovOPlaN Learning platform module seed.", "type": "module", diff --git a/pyproject.toml b/pyproject.toml index f33f003..c054c20 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "govoplan-learning" -version = "0.1.18" +version = "0.1.19" description = "GovOPlaN Learning platform module seed." readme = "README.md" requires-python = ">=3.12" diff --git a/src/govoplan_learning/backend/manifest.py b/src/govoplan_learning/backend/manifest.py index 7721472..450a5ca 100644 --- a/src/govoplan_learning/backend/manifest.py +++ b/src/govoplan_learning/backend/manifest.py @@ -6,7 +6,7 @@ from govoplan_core.core.provider_governance import declared_module_architecture MODULE_ID = "learning" MODULE_NAME = "Learning" -MODULE_VERSION = "0.1.18" +MODULE_VERSION = "0.1.19" READ_SCOPE = "learning:workspace:read" WRITE_SCOPE = "learning:workspace:write" ADMIN_SCOPE = "learning:workspace:admin" @@ -70,6 +70,13 @@ DOCUMENTATION = ( layer="available", documentation_types=("admin", "user"), audience=("user", "operator", "module_admin", "product_owner"), + translations={ + "de": { + "title": "Modulgrenze von Learning", + "summary": "Kursplanung und -buchung, Teilnehmendenlisten, Anwesenheit, Zertifikate, Zuweisung von Lehrkräften, Räume, Materialien und Evaluationen für Fortbildungen im öffentlichen Dienst.", + "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, related_modules=OPTIONAL_DEPENDENCIES, links=( @@ -80,7 +87,11 @@ DOCUMENTATION = ( ), ), metadata={ + "kind": "reference", "seed": True, + "consequence_classes": { + "seed_boundary": "Declares ownership and permissions only; no runtime workflow is available yet.", + }, "domain_objects": ['course catalogue', 'course sessions', 'participant enrolment', 'attendance facts', 'trainer and material allocation', 'evaluation records'], "first_slice": "Define course, session, participant, attendance, and certificate handoff concepts, then add tenant-local course administration.", }, diff --git a/tests/test_manifest.py b/tests/test_manifest.py index 93cbc2c..cba11b3 100644 --- a/tests/test_manifest.py +++ b/tests/test_manifest.py @@ -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({role.slug for role in manifest.role_templates}, {"learning_manager", "learning_viewer"}) 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.migration_spec) self.assertIsNone(manifest.frontend)