# Guide d'utilisation des outils
# Quels outils?
Différents outils opensource sont mis à disposition par le Health Data Hub et la Dress dans le cadre de la documentation collaborative.
Les fiches et documents sont partagés un dépôt dans Gitlab (opens new window) par les contributeurs avant d'être compilés par un logiciel Open Source Vuepress (opens new window) pour donner le site de la documentation.
# Gitlab
Les fiches contenues dans ce guide de contribution peuvent être utilisées comme mémo suite à une formation d'utilisation de Gitlab pour contribuer (opens new window) ou pour apprendre de manière autonome.
Vous retrouverez notamment:
- une fiche Markdown, format dans lequel les fiches sont rédigées
- une fiche d'introduction et navigation sur Gitlab
- Comment créer un ticket
- Comment modifier une fiche
- Comment créer une fiche
- Comment rajouter une image dans une fiche
- Comment partager un document
- Comment naviguer dans une demande de fusion
- Comment suggérer des modifications lors du processus de relecture
- quelles sont les erreurs classiques conduisant à un échec des pipelines
- Comment contribuer aux tables de données synthétiques
- La formation Gitlab ainsi que des exercices pour s'entrainer
- Des cheat sheet reprenant les points essentiels pour contribuer à la documentation via Gitlab
# Site de la documentation
Le site de la documentation est obtenu à partir de VuePress et de Gitlab. Une fiche récapitule les principales fonctionnalités du site.
# Forum entraide SNDS
Il est fortement recommandé de partager la publication de d'une fiche sur le forum d'entraide du SNDS (opens new window) pour lui donner plus de visibilité. Une fiche récapitule les principales fonctionnalités du forum.
# Comment utiliser Gitlab pour contribuer
Toute personne souhaitant contribuer est invitée à le faire. Les contributions peuvent porter sur la correction des erreurs, la mise à jour de certains champs, compléter des pages existantes, et en créer de nouvelles. Toutes améliorations, même d'apparence mineure comme la correction de fautes d'orthographe, améliorent pour tous la qualité du contenu. Un processus de relecture et de validation a été mis en place afin de garantir un contenu de qualité. Merci de s'y référer avant toute contribution.
Il est possible de contribuer de plusieurs manières :
- en créant un ticket pour signaler une erreur, proposer une nouvelle idée de fiche par exemple
- en modifiant une à plusieurs fois une fiche
- en créant une nouvelle fiche
- en partageant des programmes
