diff --git a/README.md b/README.md new file mode 100644 index 0000000..66ede04 --- /dev/null +++ b/README.md @@ -0,0 +1,84 @@ +# wiki.alpinux.org + +Documentation, guides et ressources du LUG Alpinux — Savoie. +Accessible sur `https://wiki.alpinux.org`. + +Construit avec **MkDocs Material**. Les sources sont des fichiers Markdown ; le site HTML est généré localement et synchronisé sur le serveur par rsync. + +--- + +## Flux de publication + +``` +Modifier wiki/ → git add / commit → git push → mkdocs build → rsync vers serveur +``` + +```bash +# 1. Versionner +git add . +git commit -m "..." +git push # → gitea.alpinux.org:alpinux.cedrica5l/alpinux-wiki + +# 2. Construire et déployer +mkdocs build --strict +rsync -rlcz --delete site/ alpinux.org:/var/www/clients/client1/web2/web/wiki-static/ +``` + +> Le `site/` généré n'est pas versionné (dans `.gitignore`). +> La commande rsync cible directement le DocumentRoot ISPConfig du wiki. + +--- + +## Structure des sources + +``` +wiki/ +├── mkdocs.yml # Configuration MkDocs (nav, thème, plugins) +├── docs/ # Pages Markdown +│ ├── index.md +│ ├── alpinux/ # Présentation, FAQ, événements +│ ├── guides/ # Guides pratiques (Linux Mint, Docker, chiffrement…) +│ ├── presentations/ # Supports de présentations passées +│ ├── technique/ # Documentation technique (déploiement, serveur…) +│ └── communication/ +├── overrides/ # Surcharges du thème Material +├── articles/ # Articles longs (hors nav principale) +├── code/ # Exemples de code référencés dans le wiki +└── scripts/ # Scripts utilitaires +``` + +--- + +## Développement local + +```bash +cd wiki +python3 -m venv venv && source venv/bin/activate +pip install mkdocs-material +mkdocs serve +# → http://localhost:8000 (rechargement automatique à chaque modification) +``` + +Pour vérifier que le build est propre (liens, structure) : + +```bash +mkdocs build --strict +``` + +--- + +## Déploiement serveur (ISPConfig) + +Le wiki est servi statiquement par Apache via ISPConfig : + +- DocumentRoot : `/var/www/clients/client1/web2/web/wiki-static` +- Let's Encrypt SSL activé +- Aucun service à redémarrer après rsync + +### Première synchronisation + +```bash +ssh alpinux.org "sudo mkdir -p /var/www/clients/client1/web2/web/wiki-static" +mkdocs build --strict +rsync -rlcz --delete site/ alpinux.org:/var/www/clients/client1/web2/web/wiki-static/ +```