Aller au contenu
TAAF-OPS --:-- UTC

Guide d'Utilisation des Admonitions Pédagogiques

Ce guide présente les 8 types d’admonitions personnalisées disponibles dans la documentation TAAF.


Utilisé pour lister les prérequis techniques avant de démarrer un TP ou une phase.

Code Markdown:

:::prerequis[Prérequis techniques]
Contenu ici...
:::

Points de contrôle pour vérifier que l’étudiant a bien complété une étape.

Code Markdown:

:::validation[Point de validation]
- [ ] Tâche 1
- [ ] Tâche 2
:::

Avertissements critiques, notamment pour la sécurité.

Code Markdown:

:::attention[Point de vigilance sécurité]
Contenu critique...
:::

Scénarios de test et simulations d’incidents.

Code Markdown:

:::test[Scénario de test]
Étapes du test...
:::

Explications sur l’architecture et l’infrastructure.

Code Markdown:

:::architecture[Architecture de l'infrastructure]
Description de l'architecture...
:::

Dépannage et résolution de problèmes courants.

Code Markdown:

:::troubleshooting[Problèmes courants et solutions]
Problème et solution...
:::

Notes importantes à retenir (non critiques).

Code Markdown:

:::important[Point important]
Information importante...
:::

Exercices optionnels et approfondissements.

Code Markdown:

:::bonus[Exercice bonus (optionnel)]
Contenu bonus...
:::

Toutes les admonitions peuvent être rendues pliables en utilisant ??? au lieu de !!!:

??? prerequis “Prérequis détaillés (cliquer pour déplier)” Ce contenu est masqué par défaut.

- Point 1
- Point 2
- Point 3

Code Markdown:

??? prerequis "Titre pliable"
Contenu masqué par défaut...

Pour avoir une admonition pliable mais dépliée par défaut, utilisez ???+:

???+ validation “Checklist de validation (déjà dépliée)” - [ ] Item 1 - [ ] Item 2

Code Markdown:

???+ validation "Titre (déplié par défaut)"
Contenu...

# TP 1 - Installation Falco
:::prerequis[Avant de commencer]
- VM TAAF-DOCKER-001 accessible en SSH
- Docker installé et fonctionnel
:::
## Installation
:::attention[Sécurité]
N'installez Falco qu'en mode privilégié pour la détection kernel.
:::
[Instructions d'installation...]
:::validation[Vérification]
- [ ] Falco installé
- [ ] Logs visibles dans `docker logs`
:::
## Tests
:::test[Scénario de test 1]
```bash
docker exec -it postgres-af bash

:::

---
## Récapitulatif des Types
| Type | Couleur | Icône | Usage |
|------|---------|-------|-------|
| `prerequis` | Bleu | ✓ | Prérequis techniques |
| `validation` | Vert | ✓✓ | Points de contrôle |
| `attention` | Orange | ⚠️ | Avertissements sécurité |
| `test` | Cyan | 🧪 | Scénarios de test |
| `architecture` | Indigo | 🏗️ | Explications infrastructure |
| `troubleshooting` | Jaune | 🔧 | Dépannage |
| `important` | Bleu clair | ℹ️ | Notes importantes |
| `bonus` | Or | ⭐ | Exercices optionnels |
---
**Bonne rédaction !** 📝