AGENTS - ii02735/learn-k8 GitHub Wiki

AGENTS.md

Instructions pour les agents IA qui travaillent sur ce dépôt.

Le projet

  • Ce dépôt est un wiki GitHub : https://github.com/ii02735/learn-k8/wiki.
  • Il constitue des notes d'apprentissage Kubernetes, en français, dérivées du fichier source kubernetes notes.md.
  • Dépôt distant : [email protected]:ii02735/learn-k8.wiki.git.
  • Branche de publication : master.
  • Une page rendue est accessible à https://github.com/ii02735/learn-k8/wiki/<Page>.

Règle absolue : langue

  • Tout le contenu est en français. Ne jamais traduire en anglais.
  • Conserver l'orthographe de l'auteur : « noeud » (et non « nœud »).
  • Écrire « k8s » (et non « k8 »).

Structure des pages

  • Une notion par fichier. Le nom du fichier est le titre de la page (Pods.md → /wiki/Pods).
  • Home.md : page d'accueil avec un sommaire numéroté.
  • _Sidebar.md : menu de navigation.
  • Toute nouvelle page doit être ajoutée à la fois à Home.md et à _Sidebar.md. (Exception : ce fichier AGENTS.md, purement interne, ne doit pas figurer dans la navigation.)
  • Liens internes sans extension : [Les Pods](Pods).
  • Titre en #, sections en ##, sous-sections en ###.

Style rédactionnel

  • Style pédagogique et progressif : « Qu'est-ce que… ? » → « Quand l'utiliser ? » → exemples concrets → « Les commandes principales ».
  • Pas de tableaux pour lister des ressources : l'auteur trouve qu'un tableau suggère à tort un lien entre les lignes. Préférer des listes ou des listes annotées.
  • L'auteur préfère des pages substantielles et expliquées plutôt que télégraphiques.
  • Vocabulaire technique et identifiants en code, gras pour les idées clés.
  • Émojis via shortcodes (:warning:) et alertes GitHub (> [!NOTE], > [!WARNING], > [!IMPORTANT]).
  • Bloc yaml pour les manifestes, bloc bash pour les commandes.
  • Liens croisés entre pages quand une notion en évoque une autre.

Diagrammes

  • Diagrammes vectoriels SVG dans images/, dans l'esprit des schémas draw.io d'origine (cartouches arrondis, flèches, palette bleue Kubernetes #326CE5).
  • Référencés en chemin relatif : ![description](images/ma-page.svg).
  • Valider chaque SVG : python3 -c "import xml.etree.ElementTree as ET; ET.parse('images/ma-page.svg')".
  • Ne pas utiliser de style/flex CSS dans le Markdown : GitHub les supprime.
  • Ne pas modifier les PNG d'origine importés du gist.

Workflow de publication

  1. Éditer ou créer les fichiers dans ce dépôt.
  2. Valider (SVG, liens, cohérence).
  3. git add -A && git commit -m "..." && git push (branche master).
  4. Vérifier la publication (ci-dessous).

Vérification après publication

  • La page référence bien le diagramme : curl -s https://github.com/ii02735/learn-k8/wiki/<Page> | grep -oE 'src="images/[^"]*"'
  • L'image est servie : curl -s -o /dev/null -w "%{http_code} %{content_type}" https://raw.githubusercontent.com/wiki/ii02735/learn-k8/images/<fichier> (un SVG valide renvoie 200 image/svg+xml).

À ne pas faire

  • Ne pas modifier kubernetes notes.md (fichier source d'origine, à la racine de l'espace de travail).
  • Ne pas oublier d'ajouter une nouvelle page à Home.md et _Sidebar.md.
  • Ne pas introduire de tableaux, ni écrire en anglais, ni renommer « noeud ».
  • Ne pas casser le XML d'un SVG.
  • Ne pas committer d'images inutiles.

Organisation de l'espace de travail

  • kubernetes notes.md : notes source d'origine (lecture seule).
  • kubernetes-wiki/ : clone du dépôt wiki, là où vit tout le contenu publié.

Pages du wiki

Home, Vue-d-ensemble, Les-containers, L-orchestration, Architecture-de-k8, Composants-de-k8, Noeud-maitre-vs-noeud-esclave, Namespaces, Pods, Sondes-et-cycle-de-vie, ReplicaSets, Deployments, Jobs, CronJobs, DaemonSets, StatefulSets, ConfigMaps-et-Secrets, Volumes-persistants, Services, Ingress, Gateway-API, Mise-a-l-echelle, RBAC, Helm, kubectl.

Pistes pour la suite : NetworkPolicy, requests & limits (QoS), Kustomize.

⚠️ **GitHub.com Fallback** ⚠️