Files
proxmox-snapshot-service/handbuch/mkdocs.yml
T
duffyduckandClaude Opus 5 59e7224297 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>
2026-08-09 12:39:30 +02:00

122 lines
3.2 KiB
YAML

site_name: pvesnap — Handbuch
site_description: >-
Automatische Snapshots für Proxmox VE: einrichten, Dateien zurückholen und
einen Snapshot als laufende Maschine starten.
site_author: pvesnap
copyright: Handbuch zu pvesnap
docs_dir: docs
site_dir: site
# Das Handbuch muss offline funktionieren - im Notfall steht vielleicht das
# halbe Netz. Deshalb: keine absolute site_url, keine Schriften vom CDN,
# Suchindex liegt neben den Seiten.
use_directory_urls: true
theme:
name: material
language: de
font: false # keine Google-Fonts, sonst braucht es Netz
# Bewusst nicht unter bilder/ - dort raeumt werkstatt/aufnehmen.sh auf.
favicon: stil/favicon.svg
icon:
logo: material/camera-timer
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue grey
accent: teal
toggle:
icon: material/weather-night
name: Zu dunkler Darstellung wechseln
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue grey
accent: teal
toggle:
icon: material/weather-sunny
name: Zu heller Darstellung wechseln
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.indexes
- navigation.top
- toc.follow
- search.highlight
- search.suggest
- content.code.copy
- content.tooltips
plugins:
- search:
lang: de
separator: '[\s\-\.\_/]+'
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
permalink_title: Verweis auf diesen Abschnitt
toc_depth: 3
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
extra_css:
- stil/handbuch.css
extra:
generator: false
nav:
- Start: index.md
- Schnellstart: schnellstart.md
- Installation: installation.md
- Sichern:
- sichern/index.md
- Der Konfigurationseditor: sichern/editor.md
- Zeitpläne: sichern/zeitplan.md
- Welche Gäste?: sichern/auswahl.md
- Vorhaltezeit: sichern/vorhaltezeit.md
- Im Betrieb: sichern/betrieb.md
- Daten zurückholen:
- holen/index.md
- Der Explorer: holen/explorer.md
- Die Web-Oberfläche: holen/web.md
- Wiederherstellen:
- wiederherstellen/index.md
- Eine Maschine einrichten: wiederherstellen/einrichten.md
- Damit arbeiten: wiederherstellen/arbeiten.md
- Austauschlaufwerke: wiederherstellen/transfer.md
- Dongle und USB: wiederherstellen/dongle.md
- Mit Netzwerk: wiederherstellen/netzwerk.md
- Vom Snapshot lösen: wiederherstellen/loesen.md
- Verwerfen und aufräumen: wiederherstellen/verwerfen.md
- Nachschlagen:
- nachschlagen/index.md
- Alle Befehle: nachschlagen/befehle.md
- Alle Einstellungen: nachschlagen/konfiguration.md
- Tastenkürzel: nachschlagen/tasten.md
- Speicherarten: nachschlagen/speicher.md
- Fehlersuche: nachschlagen/fehlersuche.md