UTILISER GITLAB POUR LA DOCUMENTATION SNDS
2021�
1
Programme de la formation
2
Présentation et tour de table
3
Programme de la formation
4
Le Système National des Données de Santé (SNDS historique)
5
L’accès aux données ne suffit pas pour les utiliser
SNDS historique
Nécessité d’ouverture de la connaissance et des ressources
6
Solutions proposées
Verrous dans l’utilisation des données de santé en France
7
L’open source au Health Data Hub
Gouvernance et partenariat
Outillage et maintenance
Open data
Standardisation
Animation, formation, support
Le Health Data Hub a pour objectif de favoriser le partage, sous licence ouverte, des connaissances et ressources sur le SNDS historique et autres bases de données de santé. Différents contributeurs et utilisateurs sont à l’origine de ce partage.
Projet collaboratif ouvert
WP1. Gouvernance et partenariat
8
Vision du Health Data Hub :
Une gouvernance ouverte comprenant les principaux instituts contributeurs
Gouvernance
Mise en place d’une gouvernance stratégique incluant les instituts contributeurs et une gouvernance opérationnelle pilotant le partage de ressources
Suivi des projets pilotes
Intégrer et sensibiliser des projets pilotes du HDH dans la démarche open source
Partenariats
Développer un écosystème de partenaires ayant pour objectif la mutualisation des ressources
WP2. Outillage et maintenance
9
Vision du Health Data Hub :
Proposer et maintenir une série d’outils en ligne ouverts et collaboratifs
Documentation collaborative
Documentation reprenant les concepts principaux du SNDS et répondant aux besoins des utilisateurs
Dictionnaire interactif des variables
Un dictionnaire exhaustif des bases, tables et variables du SNDS
Librairie de programmes - projet BOAS
Une librairie de programme open source en différents langages permettant de mieux exploiter les données du SNDS
Générateur de données de synthèse
Proposer un générateur de données de synthèse pour générer des jeux de données à partir du schéma d’une base
WP3. Animation, formation et support
10
Vision du Health Data Hub :
Partager, former et accompagner les utilisateurs et des contributeurs
Programmation événementielle
Proposer des évènements thématiques sur Meetup en lien avec la science ouverte et données de santé
Data Challenge
Accompagnement dans l’organisation de Data Challenge qui visent à répondre à des problématiques médicales précises à l’aide de l’analyse des données mises à disposition
Cartographie SNDS
Cartographie de l’écosystème des chercheurs utilisant le SNDS
Notebook pour se former au SNDS
Proposer des exemples types d’utilisation des données
Forum
Accompagner les utilisateurs et répondre à leurs questions sur le SNDS et Health Data Hub
WP4. Standardisation
11
Vision du Health Data Hub :
Mettre en place des projets de standardisation pour faciliter l’exploitation des données à l’échelle internationale
Appel à projet européen EHDEN
Mettre au format OMOP-CDM d’une partie du SNDS FT pour des projets de recherche sur la Covid-19
Alignement de terminologies
Aligner des terminologies françaises et internationales
Documentation
Proposer une documentation en français sur le format OMOP-CDM et sur l’omopisation du SNDS
Fédérer un écosystème français autour d’OMOP-CDM
Echanger autour des avancées en omopisation, et partage d’expérience
WP5. Open Data
12
Vision du Health Data Hub :
Développer l’open data sur des données médicales tout en préservant l’anonymat
Infrastructure d’accès
Permettre la mise en open data de données de recherche volumineuses avec un téléchargement via un questionnaire
Mise en open data des données issus des data challenge
Mettre en open data les 5 000 lames de biopsies du col de l’utérus issues du data challenge 2020
Aide à la mise en open data
Proposer une aide à la mise en open data et anonymisation de données de santé. Un premier projet est mené avec France Asso Santé
13
Contributeurs
Open Data (lien à venir)
Cartographie écosystème SNDS (lien à venir)
Huits ressources ouvertes
TP 1 : Explorer les outils
14
Documentation collaborative
15
Générateur de données de synthèse
16
Notebook pour se former
17
Dictionnaire interactif
18
Dictionnaire interactif
19
Cartographie écosystème SNDS
20
Forum d’entraide
21
Meetup
22
Programme de la formation
23
Rédiger au format Markdown
24
Rédiger au format Markdown
25
Rédiger au format Markdown
26
Rédiger au format Markdown
27
Rédiger au format Markdown
28
Rédiger au format Markdown
29
29
TP2 : Recopier le modèle
30
Programme de la formation
31
Naviguer dans Gitlab - Se connecter
32
2. S’inscrire/ s’enregistrer
2.
1. Taper dans un moteur de recherche Gitlab Health Data Hub
Naviguer dans Gitlab - Changer la langue
33
1. Aller dans les paramètres du compte pour changer la langue
1.
Naviguer dans Gitlab - Changer la langue
34
1. Aller dans préférences/Settings et descendre en bas de la page
1.
1.
Naviguer dans Gitlab - Changer la langue
35
Note : la traduction de Gitlab en Français n’est pas complète. Certains termes sont toujours en anglais.
1.
2.
3.
Naviguer dans Gitlab - Choisir le projet de contribution
36
En cliquant sur le logo, la liste des projets auxquels vous participez est disponible.
Listes des projets auxquels vous avez accès
Projet publique
Projet privé
Pour chaque projet, il est indiqué le nom, si le projet est public ou privé, votre statut (developer ou maintener), ainsi que la date de la dernière mise à jour.
Naviguer dans Gitlab - Changer la langue
37
1.
Le projet utilisé pour la documentation est Documentation collaborative du SNDS. C’est donc dans ce dernier qu’il faudra participer après la formation !
Naviguer dans Gitlab
38
Contient l’ensemble des données constituant le projet, et la totalité des historiques de modification
Discussions préparatoires / Tickets
Intégration des travaux réalisés
Chemin du projet
Naviguer dans Gitlab - Dépôt
39
Dossiers
1. Aller dans Dépôt > fichiers
Le dépôt contient l’ensemble des données constituant le projet et la totalité des historiques de modification.
Les fiches de la documentation sont contenues dans le dossier fiches.
C’est donc dans ce dossier qu’il faudra contribuer en ajoutant de nouvelles fiches et en modifier certaines.
1.
Naviguer dans Gitlab - Fiches
40
1. Aller dans Dépôt > Fichiers > fiches > actes_consult_externes.md
Les fiches publiées sont contenues dans le dossier fiches.
1.
Permet de prévisualiser la fiche
Naviguer dans Gitlab - Fiches
41
Permet de visualiser la fiche au format markdown
Dernières modifications effectuées sur la fiche
Licence
42
Sur la documentations SNDS : licence MPL-2.0
Initiation à Git - Travail collaboratif
43
Origine du projet
1 rond = 1 commit
master
master
master
fix-orthographe
creation-fiche-cepidc
creation-fiche-cepidc
Branches de travail temporaires = travail à plusieurs
Fusion (=merge)
dans master pour récupérer le travail
branche master
= branche centrale
branche fix- orthographe
branche creation-fiche-cepidc
temps
Initiation à Git - Travail collaboratif
44
2
Créez une “copie” de la documentation pour travailler dessus via une branche
1
Annoncez ce que vous voulez faire via un ticket
3
Faites vos modifications, ajouts, corrections, etc. en éditant la branche de travail créée
5
Finissez vos modifications
4
Lorsque vous avez fini, proposez de fusionner vos travaux avec la branche principale quelque soit son état d’avancement
6
Faites relire vos modifications
7
Proposez d’intégrer vos modifications à la documentation
8
Félicitations, vous avez contribué à la documentation !
Naviguer dans Gitlab - Commit
45
1.
1. Aller dans Dépôt > Commits
Un commit est une description des modifications effectuées.
Il comprend l’auteur, la date, et une courte description des modifications/ajouts.
Naviguer dans Gitlab - Ticket
46
Les tickets sont des outils de communications autour du projet. Ils peuvent être attribués à une ou plusieurs personnes en désignant des assignés.
Les tickets peuvent être visualisés sous la forme de liste, tableaux, ou encore par étiquettes.
Naviguer dans Gitlab - Ticket
47
1. Aller dans Tickets > Liste
Les tickets sont des outils de communications autour du projet. Ils peuvent être utilisés pour signaler un problème, proposer une amélioration sur le site de la documentation, proposer une nouvelle idée de fiche.
Titre du ticket
Étiquette
Auteur ayant ouvert le ticket
Numéro du ticket
1.
Naviguer dans Gitlab - Ticket
48
1. Aller dans Tickets > Liste
Les tickets sont des outils de communications autour du projet. Ils peuvent être utilisés pour signaler un problème, proposer une amélioration sur le site de la documentation, proposer une nouvelle idée de fiche.
Une discussion peut être engagée avec les différents contributeurs.
Naviguer dans Gitlab - Ticket
49
Des étiquettes peuvent être ajoutées pour décrire les tickets.
Dans le cadre de la documentation collaborative, les étiquettes disponibles sont Rédaction, Développement, Bug, A faire, En cours, Prêt fusion
Naviguer dans Gitlab - Ticket
50
1. Aller dans Tickets > Tableaux
Tickets visualisés ici sous forme de tableau en fonction des étiquettes.
Cela permet de savoir quelles fiches sont à faire, celles qui sont en cours de rédaction et d’y contribuer éventuellement.
1.
Naviguer dans Gitlab - Retrouver son ticket
51
Liste des tickets dans lesquels vous êtes assigné
Naviguer dans Gitlab - Demandes de fusion
52
Les demandes de fusion consistent à prendre en compte les modifications apportées.
1.
Naviguer dans Gitlab - Branches
53
Le projet principal est enregistré dans une branche appelée master.
Lorsqu’un contributeur va apporter des modifications, il va les enregistrer dans une nouvelle branche.
Pour avoir accès aux différentes versions du projet, sélectionner la branche de la version voulue.
1.
Programme de la formation
54
Créer un ticket
55
2.
1.
Créer un ticket
56
2.
1.
3.
4.
5.
Créer un ticket
57
Titre
Description
Possibilité de démarrer une conversation avec d’autres personnes ou de rajouter des notes par rapport à la description initiale
Personnes assignées
Étiquettes
Participants
TP3 : Créer un ticket
58
https://formation-gitlab.documentation-snds.health-data-hub.fr/
Programme de la formation
59
Modifier une fiche - Annoncer la modification
60
Si la modification est mineure cette étape peut être sautée.
Si la modification est plus importante (ajout de code, d’un paragraphe, mise à jour etc.), la première étape est la création d’un ticket décrivant les modifications qui vont être apportées.
Se référer à la slide Créer un ticket.
Modifier une fiche - Ouvrir la fiche à modifier
61
Orthographe
1.
Modifier une fiche - Ouvrir la fiche à modifier
62
Mettre à jour cette partie
Fautes d’orthographe
Modifier une fiche - Ouvrir la fiche à modifier
63
1.
Modifier une fiche - Ouvrir la fiche à modifier
64
Nous sommes sur le point d’apporter des modifications. Une branche va devoir être créée, et les modifications seront enregistrées sur celle-ci.
Branche master
Modifier une fiche - Apporter des modifications
65
1.
Modifier une fiche - Apporter des modifications
66
2.
1.
3.
4.
5.
Modifier une fiche - Apporter des modifications
67
1.
Modifier une fiche - Apporter des modifications
68
1.
2.
3.
4.
Modifier une fiche - Enregistrer les modifications dans une nouvelle branche
69
Correction orthographe et INDS
Branche master
Branche
correction-readme-initial
Modifier une fiche - Enregistrer les modifications dans une nouvelle branche
70
Pour réaliser une demande de fusion entre sa branche de travail et la branche master il faut :
1.
2.
3.
4.
5.
orthographe et INDS
Modifier une fiche - Faire une demande de fusion
71
Pour réaliser une demande de fusion entre sa branche de travail et la branche master il faut :
1.
2.
3.
4.
5.
orthographe et INDS
Modifier une fiche - Faire une demande de fusion
72
1.
Modifier une fiche - Faire une demande de fusion
73
Enregistrer une demande de fusion ne veut pas dire que la fusion se lancera automatiquement après cette demande. Des modifications peuvent toujours être apportées sur la même fiche, dans la même demande de fusion (et donc sur la même branche).
Les demandes de fusions sont validées par certains membres de HDH.
1.
2.
Modifier une fiche - Création de la demande de fusion
74
Correction orthographe et INDS
Branche master
Branche
correction-readme-initial
Demande de fusion
Si les corrections sont terminées, demander à valider la demande de fusion à un mainteneur
Si des corrections sont encore en cours, continuer le travail sur la branche cible
Modifier une fiche - Naviguer dans une demande de fusion
75
Personnes assignées
Étiquettes
Participants (Le Health Data Hub est automatiquement déclaré en tant que participant)
Titre
Pour annuler la demande de fusion
Description
Correspond à des tests effectués.
Pour modifier la demande de fusion
orthographe et INDS
Modifier une fiche - Naviguer dans une demande de fusion
76
1.
Modifier une fiche - Naviguer dans une demande de fusion
77
1.
Le premier cercle correspond à des tests mis en place par le Health Data Hub. Ils permettent de vérifier que les liens externes et internes sont valides. En cas d’échec les logos suivants apparaissent.
Avant d’accepter une demande de fusion, ces tests sont toujours vérifiés par les mainteneurs et des corrections sont apportées en cas d’échec.
Modifier une fiche - Naviguer dans une demande de fusion
78
Le second cercle permet de générer un lien de prévisualisation du site de la documentation collaborative du SNDS. En cas d’échec, les mainteneurs s’occupent de régler le problème.
Modifier une fiche - Naviguer dans une demande de fusion
79
1.
Il est possible de comparer les différentes versions 2. côte-à-côte et de choisir quelles versions sont à comparer 3.
3.
2.
Modifier une fiche - Effectuer de nouvelles modifications
80
1.
Modifier une fiche - Effectuer de nouvelles modifications
81
1.
2.
3.
Modifier une fiche - Effectuer de nouvelles modifications
82
Ajout ARS et SpF
Branche master
Branche
correction-readme-initial
Modifier une fiche - Effectuer de nouvelles modifications
83
2.
1.
Modifier une fiche - Effectuer de nouvelles modifications
84
1.
Modifier une fiche - Inclure les modifications dans le projet principal
85
Ajout ARS et SpF
Branche master
Branche
correction-readme-initial
Demande de fusion
Modifier une fiche - Inclure les modifications dans le projet principal
86
2.
1.
3.
orthographe et INDS
Modifier une fiche - Inclure les modifications dans le projet principal
87
Les demandes de fusion sont régulièrement vérifiées par les mainteneurs du projet. L’ajout de l’étiquette Prêt fusion permet de fluidifier le processus de publication.
Seuls certains membres du projet peuvent accepter les demandes de fusion. Lors des choix des assignés, si un logo orange est présent, alors cette personne n’a pas les droits de fusion.
Bonnes pratiques pour contribuer
88
Markdown
Demande de fusion
TP4 : Corriger / modifier une fiche
89
https://formation-gitlab.documentation-snds.health-data-hub.fr/
Programme de la formation
90
Créer une nouvelle fiche
91
La première étape est la création d’un ticket. Se référer à la slide correspondante.
Créer une nouvelle fiche
92
1.
2.
Créer une nouvelle fiche
93
1.
2.
Créer une nouvelle fiche
94
1.
2.
3.
4.
5.
6.
Créer une nouvelle fiche
95
Remplir la demande de fusion de la même façon que précédemment.
1.
2.
3.
4.
Créer une nouvelle fiche
96
Remplir la demande de fusion de la même façon que précédemment.
Créer une nouvelle fiche
97
La page de demande de fusion est exactement la même que celle de la modification de fiche. Il est possible d’apporter des modifications, commencer une discussion, etc.
Bonne contribution !
98
Ceci est la fin de la formation sur comment contribuer à la documentation du SNDS par Gitlab.
Un guide de contribution est disponible dans la documentation. Il permet notamment d’apprendre à inclure des images dans les fiches.
Pour toutes questions/ blocages, n’hésitez pas nous contacter : opensource@health-data-hub.fr