Aller au contenu

Base de connaissances

Source de vérité unique pour mes procédures, configs et notes de projet.

Objectif : documenter une fois, réutiliser à l'infini. Fini le « je refais les mêmes manips en cherchant partout ».

Comment c'est organisé

  • runbooks/ — Procédures réutilisables, pas à pas, indépendantes d'un projet précis (durcissement VPS, config DNS, pipeline GitLab…). C'est le cœur de la base.
  • projets/ — Une fiche par projet : quelles ressources (VPS, domaines, DNS), quels runbooks ont été appliqués, quelles spécificités.
  • references/ — Cheatsheets, snippets de commandes, aide-mémoire courts.
  • templates/ — Modèles à copier pour créer une nouvelle entrée sans réfléchir à la structure.

Conventions (à respecter pour que la base reste utile)

  • Un fichier = un sujet. Nom en minuscules avec des tirets : durcissement-vps-ovh.md.
  • Toujours partir d'un template. C'est la régularité de structure qui rend la base fiable et rapide à parcourir.
  • Écris la procédure pendant que tu la fais, pas trois semaines après. Copie-colle les vraies commandes tant que tu les as sous les yeux.
  • Date chaque mise à jour en bas du fichier.
  • Jamais de secret dans la base. Pas de mot de passe, clé privée ou token en clair. Utilise un placeholder (<TON_TOKEN>) et garde les vrais secrets dans un gestionnaire dédié (Bitwarden / Vaultwarden, 1Password, un vault…).

Mettre le tout dans Git

cd base-de-connaissances
git init
git add .
git commit -m "Initialisation de la base de connaissances"
# puis pousse vers un repo privé GitLab
git remote add origin [email protected]:<toi>/base-de-connaissances.git
git push -u origin main

Rendre la base cherchable (optionnel mais recommandé)

Le fichier mkdocs.yml est déjà fourni. Avec MkDocs Material tu obtiens un site local avec barre de recherche :

pip install mkdocs-material
mkdocs serve      # → http://localhost:8000
mkdocs build      # génère un site statique dans site/

Tu peux même publier ce site sur un de tes sous-domaines via une pipeline GitLab (kb.exemple.com) — mais commence simple : le repo + la recherche locale suffisent largement.