Handbuch auf MkDocs-Basis, mit Bildschirmfotos aus dem Programm
26 Kapitel in vier Teilen, in der Reihenfolge, in der man sie braucht: erst sichern, dann Dateien holen, dann ganze Maschinen wiederherstellen, dahinter der Nachschlagteil. Gebaut wird mit MkDocs + Material. Bewusst ohne Netzabhaengigkeiten: keine Schriften vom CDN (font: false), Volltextsuche mit deutschem Stemming liegt neben den Seiten. Im Notfall steht vielleicht das halbe Netz - dann nuetzt eine Doku im Internet nichts. handbuch/bauen.sh baut handbuch/site/ handbuch/bauen.sh ansehen Vorschau auf 127.0.0.1:8000 install.sh nimmt das gebaute Handbuch mit nach /usr/share/doc/pvesnap/handbuch/ - falls es vorliegt. Auf dem Host selbst wird nichts gebaut, mkdocs gehoert nicht auf einen Hypervisor. Die 28 Bildschirmfotos sind nicht abfotografiert, sondern erzeugt: Der echte Programmcode laeuft in einem Pseudo-Terminal gegen einen erfundenen Proxmox-Host (Attrappen fuer pvesh, perl und rbd), pyte baut den Bildschirm nach, heraus faellt ein SVG. Damit stimmen sie garantiert mit dem Programm ueberein, sind reproduzierbar und enthalten keine echten Daten. Die Werkstatt dafuer liegt unter handbuch/werkstatt/ samt LIESMICH.md. Nebenbei: die Schlussmeldung von install.sh warb noch mit --exchange, das mit dem eingebauten Austauschlaufwerk weggefallen ist. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
co-authored by
Claude Opus 5
parent
c484596702
commit
59e7224297
Executable
+45
@@ -0,0 +1,45 @@
|
||||
#!/bin/bash
|
||||
# ---------------------------------------------------------------------
|
||||
# Alle Bildschirmfotos fuers Handbuch neu aufnehmen.
|
||||
#
|
||||
# ./aufnehmen.sh alle
|
||||
# ./aufnehmen.sh explorer nur die, deren Name das enthaelt
|
||||
#
|
||||
# Ergebnis: handbuch/docs/bilder/*.svg
|
||||
# Wie das funktioniert, steht in LIESMICH.md.
|
||||
# ---------------------------------------------------------------------
|
||||
set -euo pipefail
|
||||
|
||||
HIER="$(cd "$(dirname "$0")" && pwd)"
|
||||
HANDBUCH="$(dirname "${HIER}")"
|
||||
VENV="${HANDBUCH}/.venv"
|
||||
|
||||
info() { printf '\033[36m%s\033[0m\n' "$*"; }
|
||||
rot() { printf '\033[31m%s\033[0m\n' "$*" >&2; }
|
||||
|
||||
# unshare -r braucht Benutzer-Namensraeume; ohne sie stehen im Explorer die
|
||||
# Arbeitspfade dieser Werkstatt statt der Pfade eines echten Hosts.
|
||||
if ! unshare -r -m --propagation private true 2>/dev/null; then
|
||||
rot "Benutzer-Namensraeume sind nicht verfuegbar (unshare -r schlaegt fehl)."
|
||||
rot "Ohne sie stimmen die Pfade in den Explorer-Bildern nicht."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ ! -x "${VENV}/bin/python" ]; then
|
||||
info "Richte Bau-Umgebung in ${VENV} ein ..."
|
||||
python3 -m venv "${VENV}"
|
||||
"${VENV}/bin/pip" install --quiet --upgrade pip
|
||||
fi
|
||||
if ! "${VENV}/bin/python" -c "import pyte" 2>/dev/null; then
|
||||
info "Installiere pyte (Bildschirm-Nachbau) ..."
|
||||
"${VENV}/bin/pip" install --quiet pyte
|
||||
fi
|
||||
|
||||
info "Baue die Demo-Kulisse ..."
|
||||
"${VENV}/bin/python" "${HIER}/demo.py" >/dev/null
|
||||
|
||||
info "Nehme auf ..."
|
||||
"${VENV}/bin/python" "${HIER}/scenes.py" "$@"
|
||||
|
||||
echo
|
||||
info "Fertig: ${HANDBUCH}/docs/bilder/"
|
||||
Reference in New Issue
Block a user