diff --git a/docs/_summary.md b/docs/_summary.md index f9c3087..04b9322 100644 --- a/docs/_summary.md +++ b/docs/_summary.md @@ -22,6 +22,7 @@ * [Contribuer](contributor/index.md) * [Code de conduite](contributor/code_of_conduct.md) * [Contribuer au projet](contributor/contributing.md) + * [Contribuer pour la docs](contributor/documentation.md) * Annexes * [Glossaire](annexes/glossaire.md) * [FAQ](annexes/faq.md) diff --git a/docs/contributor/documentation.md b/docs/contributor/documentation.md new file mode 100644 index 0000000..0ec5362 --- /dev/null +++ b/docs/contributor/documentation.md @@ -0,0 +1,118 @@ +# Contributing Documentation + +Pour ce projet, nous utilisons MKdocs pour la documentation. Voici quelques informations pour vous aider à contribuer à la documentation. + +!!! abstract "Prérequis" + + Nous vous recommandons d'installer l'environnement virtuel Python pour installer MKdocs. + + Python 3.6 ou supérieur est requis pour l'installation de MKdocs. + + +## Installation de l'environnement Python + +=== ":fontawesome-brands-windows: WINDOWS via Scoop" + + Pour installation Python, ouvrez un terminal (PowerShell) pour installer le bucket : + + ```bash + scoop bucket add main + ``` + ```bash + scoop install main/python + ``` + + Pour plus informations, visitez le site [https://scoop.sh/#/apps?q=python](https://scoop.sh/#/apps?q=python&id=2dcee5c280bcf909518d9074ed86f67c984f4db0){:target="_blank"} + +=== ":fontawesome-brands-windows: WINDOWS via Chocolatey" + + Pour installation Python, ouvrez un terminal (PowerShell) pour installer le bucket : + + ```bash + choco install python + ``` + + Pour plus informations, visitez le site [https://community.chocolatey.org/packages/python](https://community.chocolatey.org/packages/python){:target="_blank"} + +=== ":fontawesome-brands-apple: MAC OS" + + Pour installation Python, ouvrez un terminal + + ```bash + brew install python@3.12 + ``` + + Pour plus informations, visitez le site [https://formulae.brew.sh/formula/python](https://formulae.brew.sh/formula/python@3.12){:target="_blank"} + + +## Installation de l'environnement virtuel Python + +Créer un environnement virtuel Python avec la commande suivante : + +```bash +python3 -m venv venv +``` +!!! abstract "ENVironnement Virtuel" + + Pourquoi utiliser un environnement virtuel Python ? [https://docs.python.org/3/library/venv.html(https://docs.python.org/3/library/venv.html){:target="_blank"} + + +## Activation de l'environnement virtuel + +Pour activer l'environnement virtuel Python, ouvrez un terminal et tapez la commande suivante : + +=== ":fontawesome-brands-windows: WINDOWS via PowerShell" + + Ouvrez un terminal (PowerShell) : + + ```bash + _venv_\Scripts\Activate.ps1 + ``` + +=== ":fontawesome-brands-windows: WINDOWS via CMD" + + Ouvrez un terminal (CMD) : + + ```bash + venv\Scripts\activate.bat + ``` + +=== ":fontawesome-brands-apple: MAC OS" + + Ouvrez un terminal + + ```bash + source venv/bin/activate + ``` + +## Installation de MKdocs + +Pour installer MKdocs, tapez la commande suivante : +Cette commande va installer MKdocs et les dépendances nécessaires. + +```bash +python -m pip install requirements.txt +``` +!!! abstract "Pour aller plus loin" + + Nous utilisons le thème "Material" pour la documentation. + + Pour plus d'informations, visitez le site [https://squidfunk.github.io/mkdocs-material/](https://squidfunk.github.io/mkdocs-material/){:target="_blank"} + +## Lancement de MKdocs + +```bash +mkdocs serve +``` + +MKdocs va lancer un serveur local pour visualiser la documentation. + +Ouvrez un navigateur et tapez l'adresse [https://127.0.0.1:8000/edu-framework/](https://127.0.0.1:8000/edu-framework/){:target="_blank"} + +!!! abstract "Une fois installé" + + Une fois installé, vous pouvez contribuer à la documentation en modifiant les fichiers Markdown dans le dossier "docs" du projet. + N'oubliez pas de travailler sur la branche "main" pour vos modifications et de faire une pull request pour les valider. + + Si vous avez fermé le terminal, n'oubliez pas d'activer l'environnement virtuel Python avant de lancer MKdocs. + \ No newline at end of file diff --git a/docs/contributor/index.md b/docs/contributor/index.md index c200992..798169f 100644 --- a/docs/contributor/index.md +++ b/docs/contributor/index.md @@ -4,6 +4,7 @@ Merci d'envisager de contribuer à notre projet ! Nous apprécions votre temps e - [Code de conduite](code_of_conduct.md) - [Ligne de contribution](contributing.md) +- [Contribuer pour la documentation](documentation.md) !!! bug "Communiquez avec nous"