Add packaged user manual and configuration guides to web console
This commit is contained in:
1 parent
b42bafb711
commit
085a5c4026
17 files changed
+586
-7
No files matched your search
@@ -15,6 +15,25 @@ Für entfernte Zugriffe HTTPS verwenden. Der Analyseworker läuft unabhängig da
|
||||
[Analyseworker](analysis-worker.md) beschrieben. Das Öffnen der Übersicht löst
|
||||
keine Modellanfragen aus.
|
||||
|
||||
## Benutzeranleitung
|
||||
|
||||
Der Reiter **Benutzeranleitung** enthält die allgemeine Bedienung und
|
||||
Funktionsweise sowie Anleitungen für Linux, Projekt-/DB-/Sourcekonfiguration,
|
||||
Übergabe-API, Analyseworker, Nutzerkonten, Integrationsschlüssel, Weboberfläche
|
||||
und Erfassungsworker. Dokumentauswahl, Inhaltsverzeichnis und interne Verweise
|
||||
erlauben Navigation ohne Server-Dateizugriff. Markdown-Downloads sind ebenfalls
|
||||
möglich. Der Reiter benötigt eine angemeldete Sitzung; sein Aufruf startet keine
|
||||
Analyse. Tabellen, Codebeispiele und Überschriften werden als sichere DOM-Elemente
|
||||
dargestellt, eingebettetes HTML wird nicht ausgeführt.
|
||||
|
||||
Für Dokumentationsänderungen die ursprünglichen Markdown-Dateien unter `docs/`
|
||||
beziehungsweise `deploy/capture-worker/README.md` bearbeiten und danach
|
||||
`python scripts/build_user_manual.py` ausführen. Die feste Auswahlliste steht im
|
||||
Skript; tatsächliche lokale Konfigurationen oder Secrets werden nicht gebündelt.
|
||||
`python scripts/build_user_manual.py --check` und die Tests erkennen veraltete
|
||||
Webfassungen. Das erzeugte `web/user-manual.json` wird mit dem Python-Paket
|
||||
ausgeliefert, sodass keine lokale Kopie des Dokumentationsordners nötig ist.
|
||||
|
||||
## Worker und Fortschritt
|
||||
|
||||
Die Startseite listet lebende Worker und darunter den jeweils bearbeiteten Fall
|
||||
|
||||
Reference in new issue
Block a user