Commit 2d9c7a44 authored by Lorien Benda's avatar Lorien Benda

modification page readme avec ajout processus relecture/validation

parent 0a9c9228
Pipeline #137958158 passed with stages
in 4 minutes and 42 seconds
......@@ -4,40 +4,58 @@
Bienvenue sur le guide de contribution !
Cette documentation est par nature collaborative.
**Toute contribution est bienvenue**.
## Quelles contributions ?
Toute contribution est la bienvenue, est soumise à la licence MPL-2.0 (comme l’ensemble du projet) et nécessite certains pré-requis de maîtrise technique (indiqués ci-dessous). Cette licence [copyleft](https://fr.wikipedia.org/wiki/Copyleft) autorise une libre réutilisation du fichier ainsi partagé. Elle impose à toute version dérivée de citer la source d'origine, et d'être publiée sous la même licence afin de garantir les mêmes droits.
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, décrit ci-dessous, a été mis en place afin de garantir un contenu de qualité.
### Signaler des erreurs ou proposer des améliorations
### Processus de relecture et validation
Chaque contribution à la documentation est soumise à une relecture par les pairs (afin d’assurer la lisibilité de la contribution ainsi que sa justesse) puis une validation par les mainteneurs afin d’être ajoutée à la documentation principale (branche master).
Les contributions visant à corriger des erreurs ou à compléter des pages existantes sont très précieuses.
Toute amélioration, même d'apparence mineure comme la correction de fautes d'orthographe, améliorera pour tous la qualité du contenu.
### Relecture
Dès lors qu’une contribution est proposée comme ajout à la documentation dans sa version public (hors travail en cours), elle doit être relue par un pairs. Pour cela, la [procédure de demande de fusion](https://documentation-snds.health-data-hub.fr/contribuer/introduction_gitlab.html#edition-en-ligne-sur-gitlab-com) doit être suivie et un relecteur doit être assigné. Ce relecteur peut-être n'importe quel membre de la communauté incluant les maintainers indiqués plus loin. Soit le relecteur invite le contributeur à modifier sa contribution, soit il l’approuve pour passer à l’étape suivante.
Vous pouvez pour cela écrire un email aux mainteneurs du projets :
- Lorien Benda - HDH <<[email protected]>>
- Olivier de Fresnoye - HDH <<[email protected]>>
- Lab santé - DREES <<[email protected]>>
### Demande d’aide expertise SNDS
Si besoin est, les experts SNDS du Health Data Hub peuvent aider à la relecture :
- Anne Cuerq ([email protected], ID gitlab: @INDS-AnneC),
- Emmanuel Stranadica ([email protected], ID gitlab: @Emmanuel_S, Health Data Hub).
Vous pouvez également utiliser le système de tickets, appelés **issues**, dans cet
[onglet](https://gitlab.com/healthdatahub/documentation-snds/issues).
Il vous faudra pour cela créer un compte sur gitlab.com.
Chaque **issue** représente une opportunité de discussion ouverte pour résoudre le problème évoqué.
Tout utilisateur inscrit sur GitLab est en capacité d'y participer.
### Correction d’une contribution
Ensuite, si une relecture appelle une correction, le contributeur est invité à modifier sa contribution et la soumettre à nouveau en suivant la même procédure.
### Validation et fusion
Enfin, après avoir été relue et approuvée, la contribution doit être validé en assignant une des personnes ci-dessous:
Lorien Benda (HDH, [email protected], ID gitlab : @lbenda)
Pierre-Alain Jachiet (Drees, [email protected], ID gitlab : @pajachiet),
Olivier de Fresnoye (HDH, [email protected] , ID gitlab : @ofrsn),
Tim Vlaar (HDH, [email protected], ID gitlab : @tim.vlaar),
Salma El Oualydy (HDH, [email protected], ID gitlab : @salmael )
Maeva Kos (HDH, [email protected], ID gitlab : @maevakos )
### Corriger ou compléter une fiche existante
## Discuter avec la communauté
### Via gitlab
Un système de [ticket](https://gitlab.com/healthdatahub/documentation-snds/-/issues) est disponible via Gitlab. Ce système permet de reporter des erreurs, proposer des améliorations ou de nouveaux sujets de fiche. Un guide d’utilisation des tickets est disponible dans la partie contribution de la [documentation collaborative](https://documentation-snds.health-data-hub.fr/contribuer/).
Vous trouverez en bas de chaque page, un lien proposant d'éditer la page.
### Via le forum d’entraide
Un [forum d’entraide](https://entraide.health-data-hub.fr/) autour du SNDS est disponible. Il constitue un espace d’interaction autour de la documentation du SNDS. Les contributeurs de la documentation sont invités à partager une annonce sur le forum pour donner plus de visibilité à leurs contributions (fiches et programmes).
### Contacter le Health Data Hub et la DREES
Il est possible de contacter par mail les responsables de la documentation ouverte du Health Data Hub et de la Dress :
- Lorien Benda - HDH <<[email protected]>>
- Olivier de Fresnoye - HDH <<[email protected]>>
- Lab santé - DREES <<[email protected]>>
Ce lien vous redirigera sur GitLab, où vous devrez être connectés pour effectuer les modifications.
La [page suivante](introduction_gitlab.md) de ce guide explique comment utiliser GitLab.
## Pré-requis et formation
### Pré-requis
La maîtrise de gitlab et la rédaction au format markdown sont des prérequis nécessaires avant de pouvoir contribuer à la documentation collaborative. Ces prérequis peuvent être acquis entre autre, à l’aide de formation dispensée par le Health Data Hub.
Nous organisons régulièrement des journées de formation (gratuite) pour utiliser GitLab.
Ces formations sont organisées via le [groupe Meetup Health-Data-Hub](https://www.meetup.com/fr-FR/Health-Data-Hub/).
### Se former pour contribuer
Des formations (en présentielle et en ligne) pour apprendre à contribuer à la documentation collaborative en passant par GitLab sont régulièrement proposées par le Health Data Hub. Les formations sont annoncées sur [meetup](https://www.meetup.com/fr-FR/Health-Data-Hub/). La présentation utilisée lors des sessions de formation est disponible en ligne et peut entièrement être utilisée pour apprendre à se former de manière autonome. Un guide de contribution est également disponible sous la forme de fiches dans la [documentation collaborative](https://documentation-snds.health-data-hub.fr/contribuer/) et contient des mémo sous la forme de Cheat Sheet. Ce guide sert de rappel suite à une formation et permet d’aller plus loin dans le processus de rédaction. Il peut également être utilisé pour apprendre à contribuer de manière autonome.
Des journées autour du SNDS sont organisées par le Health Data Hub. Ces événements sont annoncés sur [meetup](https://www.meetup.com/fr-FR/Health-Data-Hub/) et sont à retrouver en vidéo sur le site de la [documentation collaborative](https://documentation-snds.health-data-hub.fr/ressources/meetup.html).
Des journées de rédactions sont régulièrement proposées par le Health Data Hub également sur [meetup](https://www.meetup.com/fr-FR/Health-Data-Hub/). Ces journées permettent d’aider les contributeurs à publier leurs connaissances sur le site de la documentation, partager des programmes dans un dépôt spécifique sur Gitlab et d’échanger autour de notions spécifiques du SNDS.
### Partage de documents existants
## Partage de documents existants
De nombreuses organisations ont documenté le SNDS pour des besoins internes.
Ce travail n'est souvent pas accessible à la communauté plus large des utilisateurs du SNDS.
......@@ -48,28 +66,17 @@ Une contribution de grande valeur consiste donc à partager publiquement des doc
Vous avez deux options pour publier ces documents
- sur le site internet de votre organisation.
Nous les référencerons via un lien hypertexte dans la section [ressources externes](../ressources/internet.md).
Ils seront référencé par un lien hypertexte dans la section [ressources externes](../ressources/internet.md).
- sur ce site de documentation.
Nous ajouterons alors un lien de téléchargement dans la section des
[documents partagés via ce projet](../ressources/README.md), et nous les convertirons en page de documentation si approprié.
::: tip Note
Le nom de l'organisation sera indiqué dans la description du document, et dans le nom du fichier.
Une **licence MPL-2.0** est appliquée sur tous les fichiers partagés via ce site.
Un lien de téléchargement sera ajouté dans la section des
[documents partagés via ce projet](../ressources/README.md), et les documents pourront être convertis en page de documentation si cela est jugé approprié.
Cette licence [copyleft](https://fr.wikipedia.org/wiki/Copyleft)
autorise une libre réutilisation du fichier ainsi partagé.
Elle impose à toute version dérivée de citer la source d'origine,
et d'être publiée sous la même licence afin de garantir les mêmes droits.
:::
### Partage de programmes
Le partage de programmes ou scripts d'analyses est très utile pour la communauté.
Nous partageons dans les fiches de courtes sections de code illustratives.
Dans les fiches de courtes sections de code sont souvent partagées.
Les programmes plus conséquents, par exemple un script complet d'analyse, sont partagés dans le dépôt dédié [programme-snds](https://gitlab.com/healthdatahub/programmes-sdns).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment