Skip to content
Français
medium

How to read this documentation

2 min de lecture

Read this page in French

This guide shows you how to find your way around the English part of this site: where the content sits, how the interactive tools work, and what the writing conventions mean.

It is not a translation of the French page of the same name, and deliberately so: the French side has a glossary, mock exams and fifteen sections that do not exist in English. Describing them here would promise features you cannot reach. What follows describes what the English side actually offers.

What this site is for

This site helps you move from "I have heard of DevSecOps" to "I can do it". Not just tutorials: you learn why something is done before you learn how.

Security is not kept in a corner. It runs through every guide from the start. That is most visible in the GitHub Actions path, where SHA pinning, minimal permissions and provenance attestations are introduced as the workflows are built, not bolted on at the end.

The "Get started" menu

At the top of the sidebar, the Get started menu gives access to the pages you need first:

  • My Learning Path: the English home page, with everything available
  • My Training Paths: straight to the list of paths and their progress
  • Conventions: the guide you are reading
  • Who I am: who writes this site, and how the guides are produced
  • Supporting the site: what it costs to run, and how to help
  • My Blog: field reports, mostly on supply chain security

Click the menu to open or close it. Closed, it gives you back screen space.

The section tabs

Below it, a row of icons holds the English sections. They carry technical subjects only: the pages above are reachable from the Get started menu and do not appear a second time here.

TabWhat you find there
CloudCloud emulation with Feint, sovereign cloud auditing with Pépin
VirtualisationThe Incus path, from your first container to a private cloud
PipelinesThe GitHub Actions path, plus the CI/CD scanners
BlogPosts in English

Click an icon and the guides of that section appear below it. The site remembers the tab you last opened, so you come back to the same place tomorrow.

The tools for learning

Training paths and progress tracking

A training path is a reading order, not a pile of pages. Each lesson knows which one comes before and after, and the footer of every lesson carries the link to the next one.

  1. Open a path from the home page, or from its "Training path" page.

  2. Tick a lesson once you have read it. The tick is stored in your own browser, with no account and nothing sent to any server.

  3. Come back later: the cards on the home page show how far you got, and the path resumes where you stopped.

Progress is shared between languages: a path you started in French continues in English, and the other way round. It is the same course.

Clearing your browser data clears your progress

Since nothing is stored on a server, wiping site data for this domain resets every path. That is the price of not asking you to create an account.

Labs

Some lessons are labs: a complete scenario you run yourself, on your own machine or on a throwaway VM. They are marked as such in the path and count separately in the totals, because they take much longer than a reading lesson.

Every command in a lab was run before being written down. When something broke, the failure is in the guide, with the error message and the way out.

Looking for something precise? Search is reachable two ways:

  • click the Search field at the top of the page;
  • press Ctrl+K, or Cmd+K on a Mac.

Searching well

Type precise terms. "ansible playbook" works better than "how do I automate with ansible": the index is built on technical vocabulary.

Search covers the whole site, French pages included. A result whose URL does not start with /en/ is a French page.

The table of contents

On long guides, a table of contents appears to the right on a desktop screen. It shows the structure at a glance, jumps to a section when you click, and highlights where you currently are. On a phone, it sits behind a button at the top of the article.

Switching language

A FR/EN button sits in the header, on every page. It behaves in two ways:

  • the page you are reading has a translation: the button takes you to it;
  • it does not: the button takes you to the home page of the other language, rather than to an error page.

The second case is the ordinary one: 121 English pages against more than 2300 French ones.

Reading conventions

Coloured callouts

Boxes of different colours appear in the guides, and each colour means something precise:

Blue means information

Something worth knowing. A reminder, a useful detail.

Green means a tip

Advice to go faster or to do better.

Amber means careful

A frequent mistake, or something confusing. Read it properly.

Red means danger

Do not do this. It is a serious mistake.

Code blocks

Commands sit in grey blocks, with the language shown at the top (bash, yaml, python and so on).

Fenêtre de terminal
# This comment explains what the command below does
systemctl is-active --quiet nginx && echo "OK" || echo "Service stopped"

This matters: do not copy a command without reading what surrounds it. The text explains why you type it and how to check that it worked.

Pinned references

Every container image and every GitHub Action in these guides is pinned: an image carries its digest (image:tag@sha256:…), an action carries the SHA of its commit with the version in a comment. Never :latest, never @main.

That is not decoration. The site teaches supply chain security, and an example showing a mutable reference would contradict what the guide says three lines above. A deliberate counter-example carries a # ❌ marker, precisely so you can tell it apart.

What you will NOT find here

  • No magic: nobody installs Kubernetes in five minutes without understanding it
  • No blind copy and paste: every command is explained, and so is how to check it
  • No lists floating in the air: good practices come with concrete examples
  • Not everything about everything: I document what I actually use
  • No theory without practice: every concept comes with a real example

What is not translated

The English side is a growing part of the site, not a sample. What is missing today, and is not planned page by page:

  • the glossary and its tooltips, which exist in French only;
  • the mock exams and the end-of-guide quizzes, kept in French;
  • the tool catalogue and most of the reference documentation.

The French side carries all of it. Those pages are not translated, though they read well enough through a browser translation if you need them.

If you want to know who writes all this and why it is free, the about page answers both.

Key points

  • A training path is a reading order with progress tracking, stored in your browser.
  • Progress follows you across languages: it is the same course.
  • Ctrl+K searches the whole site, French pages included.
  • The FR/EN button never lands you on an error page: it falls back to the home page.
  • Callouts carry meaning: tip, caution and danger are not decoration.
  • Every image and action is pinned; a mutable reference in an example would be a # ❌ counter-example.

Is this site useful to you?

Fewer than 1% of readers support this site.

I maintain more than 700 free guides, with no ads and no tracking. Any support, even a symbolic one, helps cover hosting and keeps these resources free. Thank you for the help.

The form does not show? Open Ko-fi in a new tab.

Subscribe and follow my DevSecOps work on LinkedIn