- Objectif
L’objectif est de disposer d’une documentation accessible aisément.
GitHub est un service web d’hébergement et de gestion de développement de logiciels, utilisant le logiciel de gestion de versions Git.
Le site assure également un contrôle d’accès et des fonctionnalités destinées à la collaboration comme le suivi des bugs, les demandes de fonctionnalités, la gestion de tâches et un wiki pour chaque projet. Ainsi, le site est devenu le plus important dépôt de code au monde, utilisé comme dépôt public de projets libres ou dépôt privé d’entreprises.
C’est la raison pour laquelle nous avons souhaité l’utiliser.
- Compétences :
| Compétences BTS : | Compétences : |
| – Gérer le patrimoine informatique – Mettre à disposition des utilisateurs un service informatique | Documentation technique | Veille Utilisation du language Markdown Utilisation du language Python et les logiciels Visual Studio Code et GitHub Desktop / Git |
| Repository sur GitHub | Résultat de la documentation |
 |  |
- Publication de la documentation sur un site GitHub.
| Pour publier la documentation sur une page, il faut utiliser les actions GitHub : Il faut créer un dossier “.github” et un autre “workflows”. A l’intérieur de ce dossier, créer un fichier ci.yml. C’est dans ce fichier qu’il faut aussi indiquer les commandes à faire (comme installer des plugins). Il faut donc faire un commit avant de publier le site. |  |
| Configuration du déploiement des pages de la documentation sur GitHub pour passer du Markdown à une page HTML. Aller sur les paramètres de page GitHub sur le repository. Cliquer sur “Deploy from a branch” puis dans branch, sélectionner “gh-pages”. La documentation va donc se déployer automatiquement sous la forme du site sur GitHub. |  |