Introduction
Documentation pédagogique
Bienvenue dans cette documentation pédagogique générée automatiquement à l'aide de MkDocs et hébergée sur GitHub Pages. Cette documentation a été créée dans le but de vous fournir les informations essentielles sur le contexte commun utilisé avec vos enseignants dans les bloc 2 et 3 du BTS SIO SISR 2.
Cette production est librement inspirée de celle de Ludovic Mery, professeur d'informatique en BTS SIO au lycée Fulbert de Chartres.
Comment utiliser cette documentation
-
Navigation : Utilisez la barre de navigation sur la gauche pour accéder aux différentes sections de la documentation. Cliquez sur les liens pour explorer les sujets qui vous intéressent.
-
Recherche : Si vous recherchez des informations spécifiques, utilisez la fonction de recherche en haut de la page pour trouver rapidement ce dont vous avez besoin.
-
Contributions et Corrections : Cette documentation est hébergée sur GitHub. Si vous identifiez des erreurs, des inexactitudes ou si vous souhaitez contribuer en ajoutant du contenu, vous êtes invité à soumettre des Pull Requests.
Hébergement sur GitHub Pages
Cette documentation est automatiquement mise en ligne grâce à GitHub Pages, une fonctionnalité de GitHub qui permet de publier facilement du contenu statique. Chaque fois que des modifications sont apportées à la documentation et poussées vers la branche principale du dépôt (main), les GitHub Actions sont déclenchées pour générer et déployer automatiquement les changements dans la documentation à chaque "Push". Ce principe d'automatisation s'apparente à une approche CI/CD.
CI/CD
CI/CD est l'acronyme de Continuous Integration (Intégration Continue) et Continuous Delivery (Livraison Continue) ou Continuous Deployment (Déploiement Continu). Ces pratiques sont utilisées dans le développement logiciel et la culture DevOps pour améliorer la qualité du code et accélérer le processus de livraison des logiciels. Voici une définition rapide de chaque terme : - Continuous Integration (CI) : Pratique consistant à intégrer régulièrement les modifications de code dans un dépôt central, généralement plusieurs fois par jour. Cela permet de détecter les erreurs tôt grâce à des tests automatisés qui vérifient chaque intégration. - Continuous Delivery (CD) : Pratique qui étend CI en automatisant le processus de livraison du code jusqu'à un environnement de staging ou de pré-production. Cela permet de garantir que le code est toujours prêt à être déployé en production à tout moment. - Continuous Deployment (CD) : Variante de Continuous Delivery où le code est automatiquement déployé en production dès qu'il passe les tests automatisés. Cela permet des mises à jour fréquentes et rapides en production. Ces pratiques favorisent une approche agile et réactive, réduisent les risques et améliorent la qualité du produit final.
Outils de documentation
Il existe de nombreux outils dédiés à la documentation. Nous vous suggérons d'utiliser mkdocs.
L'ensemble des situations auxquelles vous allez être confrontés cette année devra etre documenté avec cet outil et hebergé via github pages et un compte GitHub. Vous veillerez à transmettre à vos enseignants l'URL de la documentation et à la publier sur votre Portfolio.
Si vous souhaitez utiliser d'autres outils similaires à mkdocs, cela reste bien évidemment envisageable.
À propos de la documentation Stormshield
L'intégralité des fiches techniques Stormshield présentes sur ce site est issue de la production Mise en oeuvre d'une gestion unifiée des menaces informatiques proposée dans le cadre du réseau Certa par Quentin Demoulière et Apollonie Raffalli.
Le travail important de mise en forme au format Markdown a été réalisé par Ludovic Mery.