Commit 57a43cc7 authored by Lorien Benda's avatar Lorien Benda

renommé titre guide contribution et changement ordre affichage dans config.js

parent 22760def
Pipeline #153367879 passed with stages
in 4 minutes and 56 seconds
......@@ -20,32 +20,32 @@ const sidebar = [
path: "/contribuer/",
children: [
{
title: "Guide de contribution",
path: "/contribuer/Guide_contribution",
title: "À lire",
path: "/contribuer/A_lire",
children: [
"/contribuer/Guide_contribution/contactez_nous"
"/contribuer/A_lire/contactez_nous"
]
},
{
title: "Guide d\'utilisation des outils",
path: "/contribuer/Guide_utilisation_des_outils",
title: "Guide de contribution",
path: "/contribuer/Guide_contribution",
children: [
"/contribuer/Guide_utilisation_des_outils/Utiliser_le_site_de_documentation",
"/contribuer/Guide_utilisation_des_outils/Introduction_Gitlab",
"/contribuer/Guide_utilisation_des_outils/tutoriel_markdown",
"/contribuer/Guide_utilisation_des_outils/Ticket",
"/contribuer/Guide_utilisation_des_outils/demande_fusion",
"/contribuer/Guide_utilisation_des_outils/Modifier_une_fiche",
"/contribuer/Guide_utilisation_des_outils/Creer_une_fiche",
"/contribuer/Guide_utilisation_des_outils/inclure_image",
"/contribuer/Guide_utilisation_des_outils/processus_relecture",
"/contribuer/Guide_utilisation_des_outils/erreur_pipelines",
"/contribuer/Guide_utilisation_des_outils/partage_document",
"/contribuer/Guide_utilisation_des_outils/contribution_tables",
"/contribuer/Guide_utilisation_des_outils/developpement_local",
"/contribuer/Guide_utilisation_des_outils/Cheat_Sheet.md",
"/contribuer/Guide_utilisation_des_outils/exercices_formation",
"/contribuer/Guide_utilisation_des_outils/Forum"
"/contribuer/Guide_contribution/Utiliser_le_site_de_documentation",
"/contribuer/Guide_contribution/Introduction_Gitlab",
"/contribuer/Guide_contribution/tutoriel_markdown",
"/contribuer/Guide_contribution/Ticket",
"/contribuer/Guide_contribution/Modifier_une_fiche",
"/contribuer/Guide_contribution/Creer_une_fiche",
"/contribuer/Guide_contribution/inclure_image",
"/contribuer/Guide_contribution/processus_relecture",
"/contribuer/Guide_contribution/erreur_pipelines",
"/contribuer/Guide_contribution/partage_document",
"/contribuer/Guide_contribution/demande_fusion",
"/contribuer/Guide_contribution/contribution_tables",
"/contribuer/Guide_contribution/developpement_local",
"/contribuer/Guide_contribution/Cheat_Sheet.md",
"/contribuer/Guide_contribution/exercices_formation",
"/contribuer/Guide_contribution/Forum"
]
},
"/contribuer/A_propos"
......
# Boite aux lettres
<!-- SPDX-License-Identifier: MPL-2.0 -->
Bienvenu dans la boite aux lettres du Gitlab du Health Data Hub. Vous pouvez y déposer les documents que vous souhaitez partager. Nous nous occuperons de les placer dans les dossiers adéquats et les documents pourront être convertis en page de documentation si cela est jugé approprié.
Pour partager un document dans le dossier d'une organisation directement, une [fiche explicative](../contribuer/Guide_contribution/partage_document.md) reprend les étapes essentielles.
# A lire avant de contribuer
<!-- SPDX-License-Identifier: MPL-2.0 -->
## Quelles contributions ?
Toute contribution est la bienvenue, elle sera 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 librement. Les contributions peuvent porter sur:
* la proposition d'amélioration, correction, modification ou la remontée d'une erreur rencontrée dans la documentation via l'utilisation des [Tickets](../Guide_contribution/Ticket.md),
* des [améliorations, corrections et modifications](../Guide_contribution/Modifier_une_fiche.md) directement dans une fiche,
* la [création de nouvelles fiches](../Guide_contribution/Creer_une_fiche.md)
* le [partage de sources](../Guide_contribution/partage_document.md) : pdf, présentation, programmes, _etc_.
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é.
## Processus de relecture et validation
Chaque contribution à la documentation sous la forme d'ajout de contenu 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 du projet afin d’être ajoutée à la documentation principale (branche master) au bon endroit.
### 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 pair. Pour cela, la [procédure de demande de fusion](../Guide_contribution/Introduction_Gitlab.md) 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.
### Demande d’aide expertise SNDS
Si besoin est, les experts SNDS du Health Data Hub peuvent aider à la relecture. Vous pouvez également contacter le Hub en cas de doute : <<[email protected]>>
### Correction d’une contribution
Si une relecture appelle une [correction](../Guide_contribution/Modifier_une_fiche.md), 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ée en assignant une des personnes ci-dessous:
- Lorien Benda (HDH, ID gitlab : @lbenda)
- Pierre-Alain Jachiet (Drees, ID gitlab : @pajachiet),
- Olivier de Fresnoye (HDH, ID gitlab : @ofrsn),
- Tim Vlaar (HDH, ID gitlab : @tim.vlaar),
- Salma El Oualydy (HDH, ID gitlab : @salmael )
- Maeva Kos (HDH, ID gitlab : @maevakos )
## 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 [Guide d'utilisation des outils](../Guide_contribution/Ticket.md).
### 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](../Guide_contribution/Forum.md) 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 en cas de questions, suggestions, signalements d'erreurs :
- L'équipe Open Source du Health Data Hub <<[email protected]>>
- Lab santé - DREES <<[email protected]>>
## 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.
### 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. Ce guide de contribution, également disponible sous la forme de fiches dans la documentation collaborative, contient des mémo sous la forme de Cheat Sheet et des fiches thématiques. 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 meetup SNDS sont organisés 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 annoncées 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.
......@@ -5,6 +5,9 @@
Le projet de la documentation collaborative a démarré en [février 2019](https://gitlab.com/healthdatahub/formation/documentation-snds/-/commit/5c7086aa52624c3a1c59234064f78d3a82a4b03a) à l'initiative de la Drees, de la Cnam et de l'INDS devenu le Health Data Hub.
Il est actuellement le fruit de contributions de plusieurs auteurs, et est maintenu par l'équipe Open Source du Health Data Hub.
## Gouvernance
Trois niveaux de gouvernance ont été établis dans le cadre de la documentation collaborative. Une gouvernance stratégique où les grands axes de la documentation sont discutés entre tous les partenaires. La gouvernance opérationnelle met en place les actions définies par la gouvernance stratégique et veille à mobiliser la communauté des contributeurs et à remonter les sujets importants au niveau de la gouvernance stratégique.
## Auteurs
La documentation étant collaborative, différents [auteurs/mainteneurs](https://gitlab.com/healthdatahub/documentation-snds/-/graphs/master) participent au projet.
......
......@@ -41,15 +41,15 @@ Un formulaire en bas de la page éditée permet d'enregistrer vos modifications
Une page s'ouvre alors pour configurer la demande de fusion.
- Donner un titre, remplir la description
- Ajouter des assignés pour la [relecture et validation](../Guide_contribution)
- Ajouter des assignés pour la [relecture et validation](../A_lire)
- Si le travail n’est pas fini et que des modifications seront apportées ultérieurement, cocher la case `Start the title with WIP`
- Soumettre votre merge-request en bas de page.
::: tip
Enregistrer une demande de fusion ne veut pas dire que la fusion se lancera automatiquement après cette demande. L'incorporation des modifications proposées dans la documentation nécessite une [validation](../Guide_contribution/README.md) de certains membres sur Health Data Hub. 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).
Enregistrer une demande de fusion ne veut pas dire que la fusion se lancera automatiquement après cette demande. L'incorporation des modifications proposées dans la documentation nécessite une [validation](../A_lire/README.md) de certains membres sur Health Data Hub. 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](../Guide_contribution/README.md).
Les demandes de fusions sont validées par [certains membres de HDH](../A_lire/README.md).
:::
## Naviguer dans une demande de fusion (merge-request)
......@@ -59,12 +59,12 @@ Pour apprendre à naviguer dans une demande de fusion, se reporter à la fiche [
Ce processus est décrit dans la fiche [Modifier une fiche](Modifier_une_fiche.md#apporter-des-modifications-supplémentaires-dans-la-même-demande-de-fusion)
## Suggérer des modifications
Lors du [processus de relecture](../Guide_contribution/README.md#processus-de-relecture-et-validation), des modifications peuvent être suggérées par le relecteur.
Lors du [processus de relecture](../A_lire/README.md#processus-de-relecture-et-validation), des modifications peuvent être suggérées par le relecteur.
Se référer à la fiche [processus de relecture](processus_relecture.md) dédiée.
## Incorporation des modifications dans le projet
Lorsque le [processus de relecture](../Guide_contribution/README.md#processus-de-relecture-et-validation) est terminé, les modifications peuvent être incorporées dans la documentation. Aller dans l'onglet `Vue d'ensemble` de la demande de fusion. Enlever l'étiquettes `Etape: en cours` si elle a été mise. Enlever le statut `WIP` en allant dans le bouton `Editer`. Ajouter l'étiquette `Etape : Prêt fusion`.
Lorsque le [processus de relecture](../A_lire/README.md#processus-de-relecture-et-validation) est terminé, les modifications peuvent être incorporées dans la documentation. Aller dans l'onglet `Vue d'ensemble` de la demande de fusion. Enlever l'étiquettes `Etape: en cours` si elle a été mise. Enlever le statut `WIP` en allant dans le bouton `Editer`. Ajouter l'étiquette `Etape : Prêt fusion`.
Cela permet aux mainteneurs du projet de savoir visuellement quelles demandes de fusion sont prêtes à être incorporées à la documentation.
Une description complète des demandes de fusion est disponible dans la fiche [dédiée](demande_fusion.md)
\ No newline at end of file
......@@ -31,11 +31,11 @@ Ce guide se base sur la version française de l'interface. Il est à noter que l
En cliquant sur le logo de gitlab en haut à droite, la liste des projets auxquels vous participez est disponible. Pour chaque projet, il est indiqué le nom, si le projet est public (logo de la Terre) ou privé (logo d'un cadenas), votre statut (développeur ou mainteneur), ainsi que la date de la dernière mise à jour.
### Interface Gitlab pour un projet
Après avoir sélectionné un projet, la page qui s'affiche contient:
Après avoir sélectionné un projet, la page qui s'affiche contient :
- le chemin du projet
- l'onglet [*Dépôt*](Introduction_Gitlab.md#dépôt) dans le menu à droite contient l'ensemble des données constituants le projet et la totalité des historiques de modification
- l'onglet [*Ticket*](Introduction_Gitlab.md#ticket) dans le menu déroulant contient les discussions préparatoires/Ticket
- l'onglet [*Demande de fusion*](Introduction_Gitlab.md#demande-de-fusion) permet l'intégration des travaux réalisés à la documentation
- l'onglet [*Ticket*](Introduction_Gitlab.md#ticket) dans le menu déroulant contenant les discussions préparatoires/Ticket
- l'onglet [*Demande de fusion*](Introduction_Gitlab.md#demande-de-fusion) permetant l'intégration des travaux réalisés à la documentation
Chaque élément est détaillé ci-dessous.
......@@ -56,19 +56,19 @@ En cliquant sur une fiche, une page de prévisualisation s'affiche. Cette page p
</p>
##### Commits
En cliquant sur `Dépôt`>`Commits` dans le menu à droite, l'[historique](https://gitlab.com/healthdatahub/documentation-snds/commits/master) des modifications ayant eu lieu s'affiche via des commits. Un commit est une description des modifications effectuées. Il comprends l'auteur, la date et une courte description des modifications ([exemple](https://gitlab.com/healthdatahub/documentation-snds/commit/553cdd3b07bd2853e7f642b077f48e493413c00e)).
En cliquant sur `Dépôt`>`Commits` dans le menu à droite, l'[historique](https://gitlab.com/healthdatahub/documentation-snds/commits/master) des modifications ayant eu lieu s'affiche via des commits. Un commit est une description des modifications effectuées. Il comprend l'auteur, la date et une courte description des modifications ([exemple](https://gitlab.com/healthdatahub/documentation-snds/commit/553cdd3b07bd2853e7f642b077f48e493413c00e)).
<p style="text-align:center;">
<img src="../../files/images/tutoriel_gitlab/2020-05-15_HDH_commit-depot_MLP-2.0.png" alt="changer branche" width="1000"/>
</p>
#### Ticket
Les [tickets](Ticket.md) sont des outils de communications autour du projet. Ils peuvent être attribués à une ou plusieurs personnes en désignant des assignés. 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.
Les [tickets](Ticket.md) sont des outils de communication autour du projet. Ils peuvent être attribués à une ou plusieurs personnes en désignant des assignés. 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.
Les tickets peuvent être visualisés sous la forme de liste, tableaux, ou encore par étiquettes.
##### Liste
Sous forme de liste les tickets sont classés par ordre de création. Chaque ticket comprend un numéro (`#numéro` permettant de l'identifier, un titre, la date d'ouverture ainsi que l'auteur. Des étiquettes peuvent être présentes à côté du ticket pour apporter des informations sur le type d'action à faire et l'état d'avancement. Dans le cadre de la documentation collaborative, les étiquettes disponibles sont Rédaction, Développement, Bug, A faire, En cours, Prêt fusion.
Sous forme de liste les tickets sont classés par ordre de création. Chaque ticket comprend un numéro `#numéro` permettant de l'identifier, un titre, la date d'ouverture ainsi que l'auteur. Des étiquettes peuvent être présentes à côté du ticket pour apporter des informations sur le type d'action à faire et l'état d'avancement. Dans le cadre de la documentation collaborative, les étiquettes disponibles sont Rédaction, Développement, Bug, A faire, En cours, Prêt-fusion.
Tant que le ticket est ouvert, il est classé dans l'onglet `Open`, s'il est résolu il est classé dans l'onglet `Closed`.
......
......@@ -55,7 +55,7 @@ Un formulaire en bas de la page éditée permet d'enregistrer vos modifications
Une page s'ouvre alors pour configurer la demande de fusion.
- Donner un titre, remplir la description
- Ajouter des assignés pour la [relecture et validation](../Guide_contribution/README.md#processus-de-relecture-et-validation)
- Ajouter des assignés pour la [relecture et validation](../A_lire/README.md#processus-de-relecture-et-validation)
- Si le travail n’est pas fini et que des modifications seront apportées ultérieurement, cocher la case `Start the title with WIP`
- Soumettre votre merge-request en bas de page.
......@@ -64,9 +64,9 @@ Une page s'ouvre alors pour configurer la demande de fusion.
</p>
::: tip
Enregistrer une demande de fusion ne veut pas dire que la fusion se lancera automatiquement après cette demande. L'incorporation des modifications proposées dans la documentation nécessite une [validation](../Guide_contribution/README.md#processus-de-relecture-et-validation) de certains membres sur Health Data Hub. 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).
Enregistrer une demande de fusion ne veut pas dire que la fusion se lancera automatiquement après cette demande. L'incorporation des modifications proposées dans la documentation nécessite une [validation](../A_lire/README.md#processus-de-relecture-et-validation) de certains membres sur Health Data Hub. 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](../Guide_contribution/README.md#validation-et-fusion).
Les demandes de fusions sont validées par [certains membres de HDH](../A_lire/README.md#validation-et-fusion).
:::
## Naviguer dans une demande de fusion (merge-request)
......@@ -89,11 +89,11 @@ Pour cela aller dans la barre présente à gauche de l'interface Gitlab. Aller d
</p>
## Suggérer des modifications
Lors du [processus de relecture](../Guide_contribution/README.md#processus-de-relecture-et-validation), des modifications peuvent être suggérées par le relecteur.
Lors du [processus de relecture](../A_lire/README.md#processus-de-relecture-et-validation), des modifications peuvent être suggérées par le relecteur.
Se référer à la fiche [processus de relecture](processus_relecture.md) dédiée.
## Incorporation des modifications dans le projet
Lorsque le [processus de relecture](../Guide_contribution/README.md#processus-de-relecture-et-validation) est terminé, les modifications peuvent être incorporées dans la documentation. Aller dans l'onglet `Vue d'ensemble` de la demande de fusion. Enlever l'étiquettes `Etape: en cours` si elle a été mise. Enlever le statut `WIP` en allant dans le bouton `Editer`. Ajouter l'étiquette `Etape : Prêt fusion`.
Lorsque le [processus de relecture](../A_lire/README.md#processus-de-relecture-et-validation) est terminé, les modifications peuvent être incorporées dans la documentation. Aller dans l'onglet `Vue d'ensemble` de la demande de fusion. Enlever l'étiquettes `Etape: en cours` si elle a été mise. Enlever le statut `WIP` en allant dans le bouton `Editer`. Ajouter l'étiquette `Etape : Prêt fusion`.
Cela permet aux mainteneurs du projet de savoir visuellement quelles demandes de fusion sont prêtes à être incorporées à la documentation.
\ No newline at end of file
# Guide de contribution
# Guide d'utilisation des outils
<!-- SPDX-License-Identifier: MPL-2.0 -->
## Quelles contributions ?
Toute contribution est la bienvenue, elle sera 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 librement. Les contributions peuvent porter sur:
* la proposition d'amélioration, correction, modification ou la remontée d'une erreur rencontrée dans la documentation via l'utilisation des [Tickets](../Guide_utilisation_des_outils/Ticket.md),
* des [améliorations, corrections et modifications](../Guide_utilisation_des_outils/Modifier_une_fiche.md) directement dans une fiche,
* la [création de nouvelles fiches](../Guide_utilisation_des_outils/Creer_une_fiche.md)
* le [partage de sources](../Guide_utilisation_des_outils/partage_document.md) : pdf, présentation, programmes, _etc_.
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é.
## Processus de relecture et validation
Chaque contribution à la documentation sous la forme d'ajout de contenu 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 du projet afin d’être ajoutée à la documentation principale (branche master) au bon endroit.
### 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 pair. Pour cela, la [procédure de demande de fusion](../Guide_utilisation_des_outils/Introduction_Gitlab.md) 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.
### Demande d’aide expertise SNDS
Si besoin est, les experts SNDS du Health Data Hub peuvent aider à la relecture : Anne Cuerq et Emmanuel Stranadica. Vous pouvez également contacter le Hub en cas de doute : <<[email protected]>>
### Correction d’une contribution
Si une relecture appelle une [correction](../Guide_utilisation_des_outils/Modifier_une_fiche.md), 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ée en assignant une des personnes ci-dessous:
- Lorien Benda (HDH, ID gitlab : @lbenda)
- Pierre-Alain Jachiet (Drees, ID gitlab : @pajachiet),
- Olivier de Fresnoye (HDH, ID gitlab : @ofrsn),
- Tim Vlaar (HDH, ID gitlab : @tim.vlaar),
- Salma El Oualydy (HDH, ID gitlab : @salmael )
- Maeva Kos (HDH, ID gitlab : @maevakos )
## 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 [Guide d'utilisation des outils](../Guide_utilisation_des_outils/Ticket.md).
### 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](../Guide_utilisation_des_outils/Forum.md) 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 en cas de questions, suggestions, signalements d'erreurs :
- L'équipe Open Source du Health Data Hub <<[email protected]>>
- Lab santé - DREES <<[email protected]>>
## 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.
### 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. Ce guide de contribution, également disponible sous la forme de fiches dans la documentation collaborative, contient des mémo sous la forme de Cheat Sheet et des fiches thématiques. 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 meetup SNDS sont organisés 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 annoncées 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.
## 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](https://gitlab.com/healthdatahub/documentation-snds) par les contributeurs avant d'être compilés par un logiciel Open Source [Vuepress](https://vuepress.vuejs.org/) pour donner le site de la documentation.
<p style="center">
<img src="../../files/images/tutoriel_gitlab/2020-05-10_HDH_outils-documentation_MLP-2.0.png" alt="Éditer sur GitLab" width="600"/>
</p>
### 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](https://www.meetup.com/fr-FR/Health-Data-Hub/) ou pour apprendre de manière autonome.
Vous retrouverez notamment:
- une fiche [Markdown](tutoriel_markdown.md), format dans lequel les fiches sont rédigées
- une fiche [d'introduction et navigation sur Gitlab](Introduction_Gitlab.md)
- Comment créer un [ticket](Ticket.md)
- Comment [modifier une fiche](Modifier_une_fiche.md)
- Comment [créer une fiche](Creer_une_fiche.md)
- Comment rajouter une [image](inclure_image.md) dans une fiche
- Comment [partager un document](partage_document.md)`
- Comment naviguer dans une [demande de fusion](demande_fusion.md)
- Comment suggérer des modifications lors du [processus de relecture](processus_relecture.md)
- quelles sont les erreurs classiques conduisant à un échec des [pipelines](erreur_pipelines.md)
- Comment [contribuer aux tables de données synthétiques](contribution_tables.md)
- La formation Gitlab ainsi que des [exercices](exercices_formation.md) pour s'entrainer
- Des [cheat sheet](Cheat_Sheet.md) 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](Utiliser_le_site_de_documentation.md) du site.
### Forum entraide SNDS
Il est fortement recommandé de partager la publication de d'une fiche sur le [forum d'entraide du SNDS](https://entraide.health-data-hub.fr/) pour lui donner plus de visibilité. Une fiche récapitule les [principales fonctionnalités du forum](Forum.md).
## 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](../A_lire/README.md) avant toute contribution.
Il est possible de contribuer de plusieurs manières :
- en créant un [ticket](Ticket.md) pour signaler une erreur, proposer une nouvelle idée de fiche par exemple
- en modifiant une à plusieurs fois une [fiche](Modifier_une_fiche.md)
- en créant une [nouvelle fiche](Creer_une_fiche.md)
- en partageant des [programmes](partage_document.md)
<p style="center">
<img src="../../files/images/tutoriel_gitlab/2020-05-10_HDH_procedure-contribution_MLP-2.0.png" alt="Éditer sur GitLab" width="800"/>
</p>
\ No newline at end of file
......@@ -13,7 +13,7 @@ Des étiquettes peuvent être ajoutées pour décrire les tickets. Dans le cadre
documentation collaborative, les étiquettes disponibles sont `Rédaction`, `Développement`, `Bug`,`A faire`, `En cours`, `Prêt fusion`
<p align="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_etiquette_MLP-2.0.png" width="800px"/>
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_etiquette_MLP-2.0.png" width="500px"/>
</p>
Les tickets peuvent être visualisés sous la forme de [liste](https://gitlab.com/healthdatahub/documentation-snds/-/issues), [tableaux](https://gitlab.com/healthdatahub/documentation-snds/-/boards/1086586?&label_name[]=D%C3%A9veloppement) où il est possible de trier par étiquette.
......
......@@ -3,7 +3,7 @@
Cette page contient les travaux pratiques des formations GitLab pour contribuer à la documentation.
Le support de formation ci-dessous peut être ouvert en [suivant ce lien](http://frama.link/gitlab-snds5).
Le support de formation ci-dessous peut être ouvert en [suivant ce lien](https://docs.google.com/presentation/d/e/2PACX-1vSCZjdOn5mObOv8bnkKdLfyLA0lLg9h0q0vW48sAfj_DMcbooNuLv6cTO8t06h8k-GcK0GRjSETP_RE/embed?start=false&loop=false&delayms=5000).
<style>
.responsive-wrap iframe{ max-width: 95%; }
......
......@@ -73,4 +73,4 @@ Vous pouvez ensuite intégrer l'image dans la page de documentation soit
Il faudra ensuite remplir un commit. Le nom de la branche ne doit pas être modifié. Le commit apparaitra automatiquement dans la demande de fusion créée lors du versement de l'image.
Vous pouvez ensuite continuer à apporter des modifications sur la même branche, ajouter de nouvelles images sur la même branche puis faire valider votre contribution par le [processus de relecture/validation](../Guide_contribution/README.md#processus-de-relecture-et-validation).
\ No newline at end of file
Vous pouvez ensuite continuer à apporter des modifications sur la même branche, ajouter de nouvelles images sur la même branche puis faire valider votre contribution par le [processus de relecture/validation](../A_lire/README.md#processus-de-relecture-et-validation).
\ No newline at end of file
......@@ -8,7 +8,7 @@ Une contribution de grande valeur consiste donc à partager publiquement des doc
## Où publier des documents (hors programmes) ?
Vous avez deux options pour publier ces documents
- un dossier servant de [boite aux lettres]() est disponible sur Gitlab. Vous pouvez y [déposer des documents](../Guide_utilisation_des_outils/partage_document.md). Nous nous occuperons de les placer dans les dossiers adéquats et les documents pourront être convertis en page de documentation si cela est jugé approprié.
- un dossier servant de [boite aux lettres]() est disponible sur Gitlab. Vous pouvez y déposer des documents. Nous nous occuperons de les placer dans les dossiers adéquats et les documents pourront être convertis en page de documentation si cela est jugé approprié.
- ou directement dans le dossier de votre [organisme](https://gitlab.com/healthdatahub/documentation-snds/-/tree/master/ressourceses). Les documents pourront être également être convertis en page de documentation.
......@@ -38,7 +38,7 @@ Nommez votre dossier, ajoutez un commit et enregistrez dans une branche.
## Comment téléverser un fichier
Des documents de tout format peuvent être partagés dans la documentation collaborative.
Ils seront mis à disposition via un lien de téléchargement. Le processus de téléversement est le même que dans le cas d'une [inclure_image](inclure_image.md)
Ils seront mis à disposition via un lien de téléchargement. Le processus de téléversement est le même que dans le cas d'une [image](inclure_image.md)
Pour ajouter un nouveau fichier, merci de bien vouloir :
- Vérifier que vous avez les droits pour le publier
......
# Processus de relecture
<!-- SPDX-License-Identifier: MPL-2.0 -->
Lors du [processus de relecture](../Guide_contribution/README.md#processus-de-relecture-et-validation), des modifications peuvent être suggérées par un relecteur assigné. Ce processus permet d'assurer un contenu de qualité. Le 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 d'incorporation des modifications dans la documentation.
Lors du [processus de relecture](../A_lire/README.md#processus-de-relecture-et-validation), des modifications peuvent être suggérées par un relecteur assigné. Ce processus permet d'assurer un contenu de qualité. Le 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 d'incorporation des modifications dans la documentation.
Si besoin est, les experts SNDS du Health Data Hub peuvent aider à la relecture : Anne Cuerq et Emmanuel Stranadica. Vous pouvez également contacter le Hub en cas de doute : <<[email protected]>>
......
# Guide d'utilisation des outils
<!-- SPDX-License-Identifier: MPL-2.0 -->
## 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](https://gitlab.com/healthdatahub/documentation-snds) par les contributeurs avant d'être compilés par un logiciel Open Source [Vuepress](https://vuepress.vuejs.org/) pour donner le site de la documentation.
<p style="center">
<img src="../../files/images/tutoriel_gitlab/2020-05-10_HDH_outils-documentation_MLP-2.0.png" alt="Éditer sur GitLab" width="600"/>
</p>
### 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](https://www.meetup.com/fr-FR/Health-Data-Hub/) ou pour apprendre de manière autonome.
Vous retrouverez notamment:
- une fiche [Markdown](tutoriel_markdown.md), format dans lequel les fiches sont rédigées
- une fiche [d'introduction et navigation sur Gitlab](Introduction_Gitlab.md)
- Comment créer un [ticket](Ticket.md)
- Comment [modifier une fiche](Modifier_une_fiche.md)
- Comment [créer une fiche](Creer_une_fiche.md)
- Comment rajouter une [image](inclure_image.md) dans une fiche
- Comment [partager un document](partage_document.md)`
- Comment naviguer dans une [demande de fusion](demande_fusion.md)
- Comment suggérer des modifications lors du [processus de relecture](processus_relecture.md)
- quelles sont les erreurs classiques conduisant à un échec des [pipelines](erreur_pipelines.md)
- Comment [contribuer aux tables de données synthétiques](contribution_tables.md)
- La formation Gitlab ainsi que des [exercices](exercices_formation.md) pour s'entrainer
- Des [cheat sheet](Cheat_Sheet.md) 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](Utiliser_le_site_de_documentation.md) du site.
### Forum entraide SNDS
Il est fortement recommandé de partager la publication de d'une fiche sur le [forum d'entraide du SNDS](https://entraide.health-data-hub.fr/) pour lui donner plus de visibilité. Une fiche récapitule les [principales fonctionnalités du forum](Forum.md).
## 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](../../contribuer/Guide_contribution/README.md) avant toute contribution.
Il est possible de contribuer de plusieurs manières :
- en créant un [ticket](Ticket.md) pour signaler une erreur, proposer une nouvelle idée de fiche par exemple
- en modifiant une à plusieurs fois une [fiche](Modifier_une_fiche.md)
- en créant une [nouvelle fiche](Creer_une_fiche.md)
- en partageant des [programmes](partage_document.md)
<p style="center">
<img src="../../files/images/tutoriel_gitlab/2020-05-10_HDH_procedure-contribution_MLP-2.0.png" alt="Éditer sur GitLab" width="800"/>
</p>
\ No newline at end of file
......@@ -5,6 +5,61 @@ Bienvenue sur le guide de contribution !
Cette documentation est par nature collaborative.
Un [guide de contribution](../contribuer/Guide_contribution/README.md) et un [guide d'utilisation](../contribuer/Guide_utilisation_des_outils/README.md) des outils sont disponibles dans cette section `contribuer`.
Une section [à lire](A_lire/README.md) et un [guide de contribution](Guide_contribution/README.md) sont disponibles dans cette section `contribuer`.
N'hésitez pas à vous y référer avant toute contribution. Vous pouvez [contacter](../contribuer/Guide_contribution/contactez_nous.md) le Health Data Hub en cas de questions.
\ No newline at end of file
N'hésitez pas à vous y référer avant toute contribution. Vous pouvez [contacter](A_lire/contactez_nous.md) le Health Data Hub en cas de questions.
## Quelles contributions ?
### Signaler des erreurs ou proposer des améliorations
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.
Vous pouvez pour cela écrire un email aux mainteneurs du projets:
- L'équipe Opensource - HDH <<[email protected]>>
- Lab santé - DREES <<[email protected]>>
Vous pouvez également utiliser le système de [tickets](Guide_contribution/Ticket.md), 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](https://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.
### Corriger ou compléter une fiche existante
Vous trouverez en bas de chaque page, un lien proposant d'éditer la page.
Ce lien vous redirigera sur GitLab, où vous devrez être connectés pour effectuer les modifications.
La [page suivante](Guide_contribution/Introduction_Gitlab.md) de ce guide explique comment utiliser GitLab.
La page [modifier une fiche](Guide_contribution/Modifier_une_fiche.md) explique comment compléter/modifier une fiche.
### 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.
Une contribution de grande valeur consiste donc à [partager publiquement](Guide_contribution/partage_document.md) des documents existants dans votre organisation.
::: 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.
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](Guide_contribution/partage_document.md#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.
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).
::: tip Pour Info
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/).
:::
\ No newline at end of file
......@@ -5,4 +5,4 @@ Cette partie décrit les tables du SNDS et leurs schémas.
Les informations structurées de cette section sont générées automatiquement à partir du [schema formalisé du SNDS](https://gitlab.com/healthdatahub/schema-snds), qui alimente également le [dictionnaire interactif](https://drees.shinyapps.io/dico-snds/).
Il est également possible d'ajouter des informations textuelles non structurées sur chaque page. Pour cela, veuillez consulter le [guide de contribution](../contribuer/Guide_utilisation_des_outils/contribution_tables.md) des tables.
Il est également possible d'ajouter des informations textuelles non structurées sur chaque page. Pour cela, veuillez consulter le [guide de contribution](../contribuer/Guide_contribution/contribution_tables.md) des tables.
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