fix(ui): align contextual documentation with headings

Verified with the coordinated workspace changes by devkit full run
2026-09-08T225814-186389-0000-3e3ed7cd (all seven phases passed).
This shared UI pass does not mark the individual module reviews complete.
This commit is contained in:
2026-09-09 02:03:34 +02:00
parent f2d7b9b29a
commit 26ec2ca5a9
2 changed files with 15 additions and 7 deletions
+10 -2
View File
@@ -153,7 +153,9 @@ manifest = ModuleManifest(
id="audit.read-authorized-evidence", id="audit.read-authorized-evidence",
title="Read authorized audit evidence", title="Read authorized audit evidence",
summary="Audit history explains who performed a governed action, when it happened, and which resource and trace context were involved.", summary="Audit history explains who performed a governed action, when it happened, and which resource and trace context were involved.",
body="Audit views are permission- and tenant-scoped. Entries are evidence, not editable business records. Sensitive payloads may be redacted while stable resource, actor, outcome, request, run, and trace references remain available for investigation.", body="Open the documentation book beside the audit heading to understand the displayed evidence "
"and its access boundary. "
"Audit views are permission- and tenant-scoped. Entries are evidence, not editable business records. Sensitive payloads may be redacted while stable resource, actor, outcome, request, run, and trace references remain available for investigation.",
documentation_types=("user",), documentation_types=("user",),
audience=("auditor", "tenant_admin", "operator"), audience=("auditor", "tenant_admin", "operator"),
translations={ translations={
@@ -161,6 +163,8 @@ manifest = ModuleManifest(
"title": "Berechtigte Audit-Nachweise lesen", "title": "Berechtigte Audit-Nachweise lesen",
"summary": "Der Audit-Verlauf erklärt, wer eine gesteuerte Handlung wann ausgeführt hat und welche Ressourcen- und Trace-Zusammenhänge beteiligt waren.", "summary": "Der Audit-Verlauf erklärt, wer eine gesteuerte Handlung wann ausgeführt hat und welche Ressourcen- und Trace-Zusammenhänge beteiligt waren.",
"body": ( "body": (
"Öffnen Sie das Dokumentationsbuch neben der Audit-Überschrift, um die angezeigten Nachweise "
"und ihre Zugriffsgrenzen zu verstehen. "
"Audit-Ansichten sind nach Berechtigung und Mandant begrenzt. Einträge sind Nachweise und keine bearbeitbaren Fachdaten. " "Audit-Ansichten sind nach Berechtigung und Mandant begrenzt. Einträge sind Nachweise und keine bearbeitbaren Fachdaten. "
"Sensible Nutzdaten können geschwärzt sein, während stabile Verweise auf Ressource, Akteur, Ergebnis, Anfrage, Lauf und Trace für Untersuchungen verfügbar bleiben." "Sensible Nutzdaten können geschwärzt sein, während stabile Verweise auf Ressource, Akteur, Ergebnis, Anfrage, Lauf und Trace für Untersuchungen verfügbar bleiben."
), ),
@@ -180,7 +184,9 @@ manifest = ModuleManifest(
id="audit.recording-retention-and-outbox", id="audit.recording-retention-and-outbox",
title="Operate audit recording and event delivery", title="Operate audit recording and event delivery",
summary="Audit owns durable audit records, retention operations, and the transactional platform-event outbox.", summary="Audit owns durable audit records, retention operations, and the transactional platform-event outbox.",
body="Modules record bounded audit facts through the Audit capability. Governed platform events are committed to the outbox with retry and delivery metadata so a failed consumer does not erase the originating transaction. Worker dispatch is partitioned by tenant entitlement; an unavailable consumer retains its durable delivery and records an operator-required outcome instead of acknowledging the event. Retention and destructive retirement must preserve the configured evidence and recovery guarantees.", body="Open the documentation book beside the audit heading to understand the displayed evidence "
"and its access boundary. "
"Modules record bounded audit facts through the Audit capability. Governed platform events are committed to the outbox with retry and delivery metadata so a failed consumer does not erase the originating transaction. Worker dispatch is partitioned by tenant entitlement; an unavailable consumer retains its durable delivery and records an operator-required outcome instead of acknowledging the event. Retention and destructive retirement must preserve the configured evidence and recovery guarantees.",
documentation_types=("admin",), documentation_types=("admin",),
audience=("auditor", "security_officer", "operator"), audience=("auditor", "security_officer", "operator"),
related_modules=("policy", "ops"), related_modules=("policy", "ops"),
@@ -189,6 +195,8 @@ manifest = ModuleManifest(
"title": "Audit-Aufzeichnung, Aufbewahrung und Ereigniszustellung betreiben", "title": "Audit-Aufzeichnung, Aufbewahrung und Ereigniszustellung betreiben",
"summary": "Audit verwaltet dauerhafte Audit-Datensätze, Aufbewahrungsvorgänge und die transaktionale Plattformereignis-Outbox.", "summary": "Audit verwaltet dauerhafte Audit-Datensätze, Aufbewahrungsvorgänge und die transaktionale Plattformereignis-Outbox.",
"body": ( "body": (
"Öffnen Sie das Dokumentationsbuch neben der Audit-Überschrift, um die angezeigten Nachweise "
"und ihre Zugriffsgrenzen zu verstehen. "
"Module zeichnen begrenzte Audit-Fakten über die Audit-Fähigkeit auf. Gesteuerte Plattformereignisse werden zusammen mit Wiederholungs- und Zustellmetadaten in die Outbox übernommen, sodass ein ausgefallener Verbraucher die ursprüngliche Transaktion nicht auslöscht. " "Module zeichnen begrenzte Audit-Fakten über die Audit-Fähigkeit auf. Gesteuerte Plattformereignisse werden zusammen mit Wiederholungs- und Zustellmetadaten in die Outbox übernommen, sodass ein ausgefallener Verbraucher die ursprüngliche Transaktion nicht auslöscht. "
"Die Worker-Zustellung wird nach Mandantenberechtigung getrennt; ein nicht verfügbarer Verbraucher behält seine dauerhafte Zustellung und erfasst ein Ergebnis, das einen betrieblichen Eingriff verlangt, statt das Ereignis zu bestätigen. " "Die Worker-Zustellung wird nach Mandantenberechtigung getrennt; ein nicht verfügbarer Verbraucher behält seine dauerhafte Zustellung und erfasst ein Ergebnis, das einen betrieblichen Eingriff verlangt, statt das Ereignis zu bestätigen. "
"Aufbewahrung und destruktive Ausmusterung müssen die konfigurierten Nachweis- und Wiederherstellungsgarantien erhalten." "Aufbewahrung und destruktive Ausmusterung müssen die konfigurierten Nachweis- und Wiederherstellungsgarantien erhalten."
+5 -5
View File
@@ -208,6 +208,11 @@ export default function AdminAuditPanel({ settings, auth, systemMode = false }:
<> <>
<AdminPageLayout <AdminPageLayout
title={systemMode ? I18N.systemAudit : I18N.tenantAudit} title={systemMode ? I18N.systemAudit : I18N.tenantAudit}
titleHelp={<DocumentationHelpLink
reference={{
topicId: "audit.read-authorized-evidence",
documentationType: "user"
}} />}
description={pageDescription} description={pageDescription}
loading={loading} loading={loading}
error={error} error={error}
@@ -221,11 +226,6 @@ export default function AdminAuditPanel({ settings, auth, systemMode = false }:
{I18N.exportEvidence} {I18N.exportEvidence}
</Button> </Button>
)} )}
<DocumentationHelpLink
reference={{
topicId: "audit.read-authorized-evidence",
documentationType: "user"
}} />
<Button <Button
onClick={() => setReloadToken((value) => value + 1)} onClick={() => setReloadToken((value) => value + 1)}
disabled={loading} disabled={loading}