Aller au contenu
medium

Comment lire cette documentation

14 min de lecture

Ce guide vous montre comment naviguer sur ce site. Vous allez découvrir où trouver les contenus, comment utiliser les outils interactifs, et comment adapter votre lecture à votre niveau.

Ce site vous aide à passer de “j’ai entendu parler de DevSecOps” à “je sais le faire”. Pas juste des tutoriels : on apprend d’abord pourquoi faire quelque chose, puis comment le faire.

La sécurité n’est pas dans un coin à part. Elle est présente dans chaque guide, dès le début. Vous apprenez à déployer, automatiser et gérer des systèmes en pensant sécurité dès le départ.

Ce que vous allez apprendre :

  • Comprendre pourquoi on fait les choses avant de voir comment
  • Appliquer des règles de sécurité sans être expert
  • Éviter les erreurs que d’autres ont faites avant vous
  • Savoir si une solution convient à votre situation

La sidebar (le menu à gauche) est votre point de départ pour trouver n’importe quel contenu. Elle fonctionne comme un classeur avec des tiroirs.

En haut de la sidebar, le menu Démarrer donne accès aux pages essentielles :

sidebar-demarrer

  • Learning Path : la page d’accueil avec le parcours complet
  • Conventions : ce guide que vous lisez
  • Mes Examens : tous les quiz pour tester vos connaissances
  • Mon Glossaire : les définitions de tous les termes techniques
  • Mes Outils : la liste des outils présentés sur le site

Cliquez sur le menu pour l’ouvrir ou le fermer. Quand il est fermé, vous gagnez de la place sur l’écran.

Sous “Démarrer”, le menu Sections affiche une grille d’icônes. Chaque icône représente une grande thématique du site :

IcôneSectionCe que vous y trouvez
DevSecDevSecOpsCulture, principes, fondamentaux
DocDocumenterÉcrire de la documentation technique
SysSystèmesAdministration Linux, serveurs
NetRéseauxTCP/IP, DNS, routage, firewalls
DevDévelopperPython, scripts, APIs
SécuSécuritéDurcissement, analyse, détection
SvcServicesNginx, HAProxy, bases de données
VirtVirtualisationVMs, KVM, Proxmox
IaCInfrastructure as CodeTerraform, Ansible, Packer
ContConteneursDocker, Kubernetes, Podman
ObsObservabilitéLogs, métriques, alertes
CloudCloudAWS, Outscale, providers
CI/CDPipelinesGitLab CI, GitHub Actions, Jenkins
HomeLabHomelabMonter son lab personnel
BlogBlogArticles et actualités

Comment ça marche : cliquez sur une icône, et la liste des guides de cette section apparaît en dessous. Cliquez sur une autre icône pour changer de section.

Le site propose plusieurs outils pour vous aider à comprendre et retenir.

Le vocabulaire DevSecOps contient beaucoup de mots techniques. Pour vous aider, les termes du glossaire sont surlignés dans les articles.

Quand vous lisez un guide, certains mots ont un soulignement en pointillés. Passez votre souris dessus : une bulle apparaît avec la définition courte. Cliquez sur le mot pour voir la définition complète dans le glossaire.

tooltip-glossaire

Activer/désactiver les tooltips : dans le header du site, un bouton permet de basculer entre les modes :

  • Glossaire activé : les termes sont soulignés en pointillé, les tooltips s’affichent au survol
  • Glossaire désactivé : le texte apparaît normalement, sans surcharge visuelle

glossaire-toggle

Les examens permettent de vérifier ce que vous avez appris. Ce ne sont pas des pièges : ils sont là pour vous aider à trouver ce qu’il faut revoir.

page-examen

Comment ça marche :

  1. Choisissez un niveau avec les boutons de couleur (vert = facile, rouge = difficile)

  2. Cliquez sur “Démarrer le quiz” — le chronomètre commence

  3. Répondez aux questions — vous pouvez naviguer entre elles

  4. Voyez vos résultats — chaque réponse a une explication

Les questions changent à chaque fois : elles sont tirées au hasard. Les réponses aussi sont mélangées. Impossible d’apprendre par cœur !

Types de questions :

  • QCM : plusieurs choix, une seule bonne réponse
  • Vrai/Faux : c’est vrai ou c’est faux ?
  • Mot à trouver : tapez le terme technique demandé

Certaines pages affichent une roadmap — une carte visuelle des sujets à apprendre. C’est comme un arbre généalogique : on voit ce qu’il faut connaître avant d’aborder un sujet.

Le problème : sur un téléphone ou une tablette, la roadmap peut être difficile à lire car elle prend beaucoup de place.

La solution : cliquez sur le bouton “Ouvrir en plein écran” (l’icône avec les flèches qui s’écartent).

bouton-fullscreen

Une nouvelle page s’ouvre avec la roadmap en grand. Vous pouvez :

  • Zoomer avec les boutons + et -
  • Déplacer la carte en glissant avec le doigt ou la souris
  • Cliquer sur un bloc pour voir les détails
  • Revenir avec le bouton “Retour” en haut à gauche

roadmap-plein-ecran

Certains guides ont une section FAQ (questions fréquentes) en bas de page. On y trouve :

  • Les questions que tout le monde pose
  • Les cas particuliers pas détaillés dans le guide
  • Les erreurs courantes à éviter

faq-example

Comment ça marche : cliquez sur une question, la réponse se déplie. Les réponses peuvent contenir du code, des liens et des exemples.

Vous cherchez quelque chose de précis ? Utilisez la recherche. Elle est accessible de deux façons :

  • Cliquez sur le champ “Rechercher” en haut de la page
  • Tapez Ctrl+K (ou Cmd+K sur Mac)

search-example

La recherche trouve les résultats dans :

  • Les titres des pages
  • Le contenu des guides
  • Les mots du glossaire

Sur les guides longs, une table des matières apparaît à droite de la page (sur ordinateur). Elle vous aide à :

  • Voir la structure du guide d’un seul coup d’œil
  • Aller directement à une section en cliquant dessus
  • Savoir où vous êtes dans le guide (la section en cours est surlignée)

Sur téléphone, la table des matières est accessible via un bouton en haut de l’article.

Pour vous aider à tirer le meilleur parti de cette documentation, voici quelques conseils sur comment lire les guides selon votre profil et vos objectifs. J’utilise autant que possible des encadrés, des blocs de code commentés, et des quiz pour renforcer l’apprentissage.

Dans les guides, vous verrez des boîtes de couleur. Chaque couleur a un sens :

Les commandes à taper sont dans des blocs gris. Le langage est indiqué en haut (bash, yaml, python…).

Fenêtre de terminal
# Ce commentaire explique ce que fait la commande en dessous
systemctl is-active --quiet nginx && echo "OK" || echo "Service arrêté"

Important : ne copiez pas les commandes sans lire ce qui est écrit autour. Le texte explique pourquoi on tape cette commande et comment vérifier qu’elle a marché.

  • Pas de magie : on n’installe pas Kubernetes en 5 minutes sans comprendre ce qu’on fait
  • Pas de copier-coller aveugle : chaque commande est expliquée (pourquoi on la tape, comment vérifier qu’elle marche)
  • Pas de listes en l’air : les bonnes pratiques viennent avec des exemples concrets
  • Pas tout sur tout : je documente ce que j’utilise vraiment, pas une encyclopédie
  • Pas de théorie sans pratique : chaque concept a un exemple réel

Vous avez repéré une erreur, une information obsolète ou vous souhaitez proposer une amélioration ? Rejoignez le Discord pour échanger et contribuer.

  • Exploitez les fonctionnalités interactives : glossaire, quiz, FAQ, recherche
  • Adaptez le glossaire à votre niveau : activé pour découvrir, désactivé pour lire vite
  • Utilisez la recherche : Ctrl+K est votre ami pour trouver rapidement
  • Suivez les encadrés : tip, caution, danger résument les points essentiels
  • La documentation est modulaire : chaque guide peut être lu indépendamment
  • Validez avec les quiz : ils sont là pour ancrer les connaissances, pas pour évaluer

Ce site vous est utile ?

Sachez que moins de 1% des lecteurs soutiennent ce site.

Je maintiens +700 guides gratuits, sans pub ni tracing. Aujourd'hui, ce site ne couvre même pas mes frais d'hébergement, d'électricité, de matériel, de logiciels, mais surtout de cafés.

Un soutien régulier, même symbolique, m'aide à garder ces ressources gratuites et à continuer de produire des guides de qualité. Merci pour votre appui.