2 Commits
Author SHA1 Message Date
zemion 95b6be029b docs: complete German structured documentation
Module Package Release / publish-packages (push) Successful in 10s
2026-08-24 01:15:40 +02:00
zemion 5ced341e3d docs: complete public documentation baseline
Module Package Release / publish-packages (push) Successful in 10s
2026-08-22 07:55:19 +02:00
5 changed files with 43 additions and 3 deletions
+1 -1
View File
@@ -1,6 +1,6 @@
{
"name": "@govoplan/resources",
"version": "0.1.18",
"version": "0.1.20",
"private": true,
"description": "GovOPlaN Resources platform module seed.",
"type": "module",
+1 -1
View File
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
[project]
name = "govoplan-resources"
version = "0.1.18"
version = "0.1.20"
description = "GovOPlaN Resources platform module seed."
readme = "README.md"
requires-python = ">=3.12"
@@ -0,0 +1,12 @@
"""German translations for public structured documentation metadata."""
from __future__ import annotations
from typing import Any
GERMAN_STRUCTURED_TRANSLATIONS: dict[str, dict[str, Any]] = {'resources.module-boundary': {'consequence_classes': {'seed_boundary': 'Erklärt nur Besitz und '
'Berechtigungen an; es ist '
'noch kein '
'Laufzeit-Workflow '
'verfügbar.'}}}
+20 -1
View File
@@ -1,12 +1,15 @@
from __future__ import annotations
from govoplan_core.core.modules import with_documentation_structured_translations
from govoplan_resources.backend.german_structured_documentation import GERMAN_STRUCTURED_TRANSLATIONS
from govoplan_core.core.access import CAPABILITY_AUTH_PERMISSION_EVALUATOR, CAPABILITY_AUTH_PRINCIPAL_RESOLVER
from govoplan_core.core.modules import DocumentationLink, DocumentationTopic, ModuleManifest, PermissionDefinition, RoleTemplate
from govoplan_core.core.provider_governance import declared_module_architecture
MODULE_ID = "resources"
MODULE_NAME = "Resources"
MODULE_VERSION = "0.1.18"
MODULE_VERSION = "0.1.20"
READ_SCOPE = "resources:workspace:read"
WRITE_SCOPE = "resources:workspace:write"
ADMIN_SCOPE = "resources:workspace:admin"
@@ -68,6 +71,13 @@ DOCUMENTATION = (
layer="available",
documentation_types=("admin", "user"),
audience=("user", "operator", "module_admin", "product_owner"),
translations={
"de": {
"title": "Modulgrenze von Resources",
"summary": "Gemeinsames Ressourceninventar für Räume, Fahrzeuge, Geräte, Schalter, Labore, Kabinen, Ausstattung, Verfügbarkeitsregeln, Wartungssperren, Kapazitäten und Barrierefreiheitsmetadaten.",
"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=(
@@ -78,7 +88,11 @@ DOCUMENTATION = (
),
),
metadata={
"kind": "reference",
"seed": True,
"consequence_classes": {
"seed_boundary": "Declares ownership and permissions only; no runtime workflow is available yet.",
},
"domain_objects": ['resource inventory', 'availability rules', 'capacity and accessibility metadata', 'maintenance blocks', 'resource classification'],
"first_slice": "Create the resource catalogue model and expose resource availability metadata for booking and facilities modules.",
},
@@ -107,5 +121,10 @@ manifest = ModuleManifest(
)
manifest = with_documentation_structured_translations(
manifest, locale="de", translations=GERMAN_STRUCTURED_TRANSLATIONS
)
def get_manifest() -> ModuleManifest:
return manifest
+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({role.slug for role in manifest.role_templates}, {"resources_manager", "resources_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)