From 610a4d9e0ee7ceac8c0f20789b090b2ecf0bb86c Mon Sep 17 00:00:00 2001 From: Wolfgang Date: Sat, 24 Jan 2026 22:50:54 +0100 Subject: [PATCH] docs: Add Wiki setup instructions for Gitea --- WIKI_SETUP.md | 169 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 169 insertions(+) create mode 100644 WIKI_SETUP.md diff --git a/WIKI_SETUP.md b/WIKI_SETUP.md new file mode 100644 index 0000000..c1df667 --- /dev/null +++ b/WIKI_SETUP.md @@ -0,0 +1,169 @@ +# Wiki-Setup für Gitea + +Die Wiki-Dokumentation ist bereits im Repository unter `wiki/` verfügbar. + +## Option 1: Gitea Wiki aktivieren (Empfohlen) + +1. Gehen Sie zu Ihrem Repository in Gitea: + ``` + https://backoffice.userman.de/MediaMetz/customer-installer + ``` + +2. Klicken Sie auf **Settings** (Einstellungen) + +3. Unter **Features** aktivieren Sie: + - ☑ **Wiki** (Enable Wiki) + +4. Klicken Sie auf **Update Settings** + +5. Gehen Sie zum **Wiki**-Tab in Ihrem Repository + +6. Klicken Sie auf **New Page** und erstellen Sie die erste Seite "Home" + +7. Kopieren Sie den Inhalt aus `wiki/Home.md` + +8. Wiederholen Sie dies für alle Wiki-Seiten: + - Home.md + - Installation.md + - Credentials-Management.md + - Testing.md + - Architecture.md + - Troubleshooting.md + - FAQ.md + +## Option 2: Wiki via Git klonen und pushen + +Nachdem das Wiki in Gitea aktiviert wurde: + +```bash +# Wiki-Repository klonen +git clone ssh://backoffice.userman.de:2223/MediaMetz/customer-installer.wiki.git + +# In Wiki-Verzeichnis wechseln +cd customer-installer.wiki + +# Wiki-Dateien kopieren +cp /root/customer-installer/wiki/*.md . + +# Dateien hinzufügen +git add *.md + +# Commit +git commit -m "Add comprehensive wiki documentation" + +# Push +git push origin master +``` + +## Option 3: Direkt im Gitea Web-Interface + +1. Gehen Sie zu: https://backoffice.userman.de/MediaMetz/customer-installer/wiki + +2. Klicken Sie auf **New Page** + +3. Für jede Seite: + - Seitenname eingeben (z.B. "Home", "Installation", etc.) + - Inhalt aus entsprechender .md-Datei kopieren + - Speichern + +## Wiki-Seiten-Übersicht + +Die folgenden Seiten sollten erstellt werden: + +1. **Home** (`wiki/Home.md`) + - Wiki-Startseite mit Navigation + - System-Übersicht + - Schnellstart + +2. **Installation** (`wiki/Installation.md`) + - Installations-Anleitung + - Parameter-Dokumentation + - Post-Installation + +3. **Credentials-Management** (`wiki/Credentials-Management.md`) + - Credentials-Verwaltung + - Update-Workflows + - Sicherheit + +4. **Testing** (`wiki/Testing.md`) + - Test-Suites + - Test-Durchführung + - Erweiterte Tests + +5. **Architecture** (`wiki/Architecture.md`) + - System-Architektur + - Komponenten + - Datenfluss + +6. **Troubleshooting** (`wiki/Troubleshooting.md`) + - Problemlösung + - Häufige Fehler + - Diagnose-Tools + +7. **FAQ** (`wiki/FAQ.md`) + - Häufig gestellte Fragen + - Antworten mit Beispielen + +## Automatisches Setup-Script + +Alternativ können Sie dieses Script verwenden (nachdem Wiki in Gitea aktiviert wurde): + +```bash +#!/bin/bash +# setup-wiki.sh + +WIKI_DIR="/tmp/customer-installer.wiki" +SOURCE_DIR="/root/customer-installer/wiki" + +# Wiki klonen +git clone ssh://backoffice.userman.de:2223/MediaMetz/customer-installer.wiki.git "$WIKI_DIR" + +# In Wiki-Verzeichnis wechseln +cd "$WIKI_DIR" + +# Wiki-Dateien kopieren +cp "$SOURCE_DIR"/*.md . + +# Git-Konfiguration +git config user.name "Customer Installer" +git config user.email "admin@userman.de" + +# Dateien hinzufügen +git add *.md + +# Commit +git commit -m "Add comprehensive wiki documentation + +- Add Home page with navigation +- Add Installation guide +- Add Credentials-Management documentation +- Add Testing guide +- Add Architecture documentation +- Add Troubleshooting guide +- Add FAQ + +Total: 7 pages, 2800+ lines of documentation" + +# Push +git push origin master + +echo "Wiki successfully uploaded!" +``` + +## Hinweise + +- Das Wiki verwendet Markdown-Format +- Interne Links funktionieren automatisch (z.B. `[Installation](Installation.md)`) +- Bilder können im Wiki-Repository gespeichert werden +- Das Wiki hat ein separates Git-Repository + +## Support + +Bei Problemen: +1. Prüfen Sie, ob das Wiki in den Repository-Settings aktiviert ist +2. Prüfen Sie SSH-Zugriff: `ssh -T git@backoffice.userman.de -p 2223` +3. Prüfen Sie Berechtigungen im Repository + +--- + +**Alle Wiki-Dateien sind bereits im Repository unter `wiki/` verfügbar und können direkt verwendet werden!**