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
+30
-2
@@ -211,6 +211,22 @@ if [ -f "${SRC}/README.md" ]; then
|
||||
install -m 0644 "${SRC}/README.md" "${DOC_DIR}/README.md"
|
||||
fi
|
||||
|
||||
# --- Handbuch ---------------------------------------------------------
|
||||
# Nur kopieren, wenn es gebaut vorliegt (handbuch/bauen.sh). Auf dem Host
|
||||
# selbst wird nichts gebaut - mkdocs gehoert nicht auf einen Hypervisor.
|
||||
# Das gebaute Handbuch ist reines HTML samt Suche und braucht kein Netz.
|
||||
if [ -d "${SRC}/handbuch/site" ]; then
|
||||
info "Installiere Handbuch nach ${DOC_DIR}/handbuch"
|
||||
rm -rf "${DOC_DIR}/handbuch"
|
||||
install -d -m 0755 "${DOC_DIR}/handbuch"
|
||||
cp -r "${SRC}/handbuch/site/." "${DOC_DIR}/handbuch/"
|
||||
find "${DOC_DIR}/handbuch" -type d -exec chmod 0755 {} +
|
||||
find "${DOC_DIR}/handbuch" -type f -exec chmod 0644 {} +
|
||||
HANDBUCH=1
|
||||
elif [ -d "${SRC}/handbuch" ]; then
|
||||
info "Handbuch liegt nur als Quelle vor - bauen mit: handbuch/bauen.sh"
|
||||
fi
|
||||
|
||||
# --- systemd ----------------------------------------------------------
|
||||
info "Installiere systemd-Unit ${UNIT}"
|
||||
install -m 0644 "${SRC}/systemd/pvesnap.service" "${UNIT}"
|
||||
@@ -288,10 +304,22 @@ Fertig.
|
||||
|
||||
Einen Snapshot als Maschine starten:
|
||||
pvesnap-recovery Uebersicht und Assistent
|
||||
pvesnap-recovery live 100 --exchange ja
|
||||
abgeschottet ohne Netz, mit Austauschverzeichnis
|
||||
pvesnap-recovery live 100 --transfer dumps
|
||||
abgeschottet ohne Netz, mit Austauschlaufwerk
|
||||
EOF
|
||||
|
||||
if [ "${HANDBUCH:-0}" -eq 1 ]; then
|
||||
cat <<EOF
|
||||
|
||||
Handbuch (funktioniert ohne Netz, mit Volltextsuche):
|
||||
|
||||
${DOC_DIR}/handbuch/index.html
|
||||
|
||||
Im Browser oeffnen, oder vom Arbeitsplatz aus holen:
|
||||
scp -r root@\$(hostname -f):${DOC_DIR}/handbuch .
|
||||
EOF
|
||||
fi
|
||||
|
||||
if [ "$WEB" -eq 1 ]; then
|
||||
cat <<EOF
|
||||
|
||||
|
||||
Reference in New Issue
Block a user