Titre du document

Table des matières

Pour insérer la table des matières :

{:toc}

Introduction, contexte, définitions et objectifs

Le but de cette partie est d’introduire, contextualiser et définir les objectifs et intérêts de cette documention : Quoi, pourquoi, dans quel but, comment etc.

Prérequis

Tout est dans le titre. Ici il faut indiquer dans quel environnement a été réalisé cette documentation. OS / CPU / Stockage / RAM / Interface réseau / etc.

Installation et configuration

Ici détailler la procédure en utilisant des sous-titres pour chaque partie.

• Utiliser les bloc de code en indiquant le language (bash, yaml, etc.)
• Expliquer ce que fait chaque commande et les valeurs passer en paramètre si pertinant.
• Indiquer également les retours attendu dans le temrinal après une commande, ou les moyens de vérifications du bon déroulement d’une commande.

Exemple sous partie 1 : base de donée

Installer la base de donnée avec cette commande :

sudo apt install mariabd

Exemple sous partie 2 : serveur web

Installer le serveur web nginx avec cette commande :

sudo apt install nginx

Problèmes rencontré :

Ici indiquer les problèmes rencontrés et leur moyen de résolution.

Sources :

Ici lister les sources

• Documentation du site officiel de l’éditeur
• Documentation de blog (ex : IT-Connect, Blog de Stéphane Robert, etc.)
• Si IA utilisé, ne pas écrire “Claude” ou autre dans les sources, mais partager le lien de la conversation si possible.