Guide d'Utilisation des Admonitions Pédagogiques
Ce guide présente les 8 types d’admonitions personnalisées disponibles dans la documentation TAAF.
1. Prerequis (Bleu)
Section intitulée « 1. Prerequis (Bleu) »Utilisé pour lister les prérequis techniques avant de démarrer un TP ou une phase.
Code Markdown:
:::prerequis[Prérequis techniques]Contenu ici...:::2. Validation (Vert)
Section intitulée « 2. Validation (Vert) »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:::3. Attention (Orange)
Section intitulée « 3. Attention (Orange) »Avertissements critiques, notamment pour la sécurité.
Code Markdown:
:::attention[Point de vigilance sécurité]Contenu critique...:::4. Test (Cyan)
Section intitulée « 4. Test (Cyan) »Scénarios de test et simulations d’incidents.
Code Markdown:
:::test[Scénario de test]Étapes du test...:::5. Architecture (Indigo)
Section intitulée « 5. Architecture (Indigo) »Explications sur l’architecture et l’infrastructure.
Code Markdown:
:::architecture[Architecture de l'infrastructure]Description de l'architecture...:::6. Troubleshooting (Jaune)
Section intitulée « 6. Troubleshooting (Jaune) »Dépannage et résolution de problèmes courants.
Code Markdown:
:::troubleshooting[Problèmes courants et solutions]Problème et solution...:::7. Important (Bleu clair)
Section intitulée « 7. Important (Bleu clair) »Notes importantes à retenir (non critiques).
Code Markdown:
:::important[Point important]Information importante...:::8. Bonus (Or/Doré)
Section intitulée « 8. Bonus (Or/Doré) »Exercices optionnels et approfondissements.
Code Markdown:
:::bonus[Exercice bonus (optionnel)]Contenu bonus...:::Admonitions Pliables (Collapsible)
Section intitulée « Admonitions Pliables (Collapsible) »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 3Code 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...Combinaisons et Bonnes Pratiques
Section intitulée « Combinaisons et Bonnes Pratiques »Exemple de TP complet
Section intitulée « Exemple de TP complet »# 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]```bashdocker 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 !** 📝