Commit 301e879e authored by Lorien Benda's avatar Lorien Benda

'restructuration sous dossier''

parent 3919e9ca
Pipeline #141047657 failed with stages
in 3 minutes and 3 seconds
const sb = require('./sidebar');
const sb = require("./sidebar");
const sidebar = [
{
title: 'Introduction',
path: '/introduction/',
title: "Introduction",
path: "/introduction/",
children: [
'/introduction/01-snds',
'/introduction/02-bases-snds',
'/introduction/03-acces-snds',
'/introduction/04-recherche-snds'
"/introduction/01-snds",
"/introduction/02-bases-snds",
"/introduction/03-acces-snds",
"/introduction/04-recherche-snds"
]
},
sb.getSidebarGroup("fiches"),
......@@ -16,40 +16,63 @@ const sidebar = [
sb.getSidebarGroup("ressources"),
sb.getSidebarGroup("tables"),
{
title: 'Contribuer',
path: '/contribuer/',
title: "Contribuer",
path: "/contribuer/",
children: [
'/contribuer/',
'/contribuer/introduction_gitlab',
'/contribuer/tutoriel_markdown',
'/contribuer/nouveau_fichier',
'/contribuer/nouvelle_page',
'/contribuer/contribution_tables',
'/contribuer/developpement_local',
'/contribuer/exercices_formation',
'/contribuer/Cheat_Sheet'
{
title: "Guide de contribution",
children: [
"/contribuer/Guide_contribution/README.md",
"/contribuer/Guide_contribution/Contribuer_à_la_documentation.md",
"/contribuer/Guide_contribution/partager_des_sources.md",
"/contribuer/Guide_contribution/contactez_nous.md",
]
},
{
title: "Guide d\'utilisation des outils",
children: [
"/contribuer/Guide_utilisation_des_outils/README",
"/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/Modifier_une_fiche",
"/contribuer/Guide_utilisation_des_outils/Créer_une_fiche",
"/contribuer/Guide_utilisation_des_outils/contribution_tables",
"/contribuer/Guide_utilisation_des_outils/Forum",
"/contribuer/Guide_utilisation_des_outils/developpement_local",
"/contribuer/Guide_utilisation_des_outils/Cheat_Sheet.md",
"/contribuer/Guide_utilisation_des_outils/exercices_formation",
]
},
{
title: "A propos",
children: [
"/A_propos/",
]
}
]
}
];
module.exports = {
title: 'Documentation du SNDS',
title: "Documentation du SNDS",
description: "Projet collaboratif pour documenter et faciliter l'utilisation du SNDS",
themeConfig: {
repo: 'https://gitlab.com/healthdatahub/documentation-snds',
repo: "https://gitlab.com/healthdatahub/documentation-snds",
docsDir: '.',
editLinks: true,
nav: [
{text: 'Forum entraide', link: 'https://entraide.health-data-hub.fr/'},
{text: 'Dico interactif', link: 'https://drees.shinyapps.io/dico-snds/'},
{text: 'Groupe Meetup', link: 'https://www.meetup.com/fr-FR/Health-Data-Hub/'},
{text: "Forum entraide", link: "https://entraide.health-data-hub.fr/"},
{text: "Dico interactif", link: "https://drees.shinyapps.io/dico-snds/"},
{text: "Groupe Meetup", link: "https://www.meetup.com/fr-FR/Health-Data-Hub/"},
],
sidebar: sidebar,
sidebarDepth: 1,
lastUpdated: 'Dernière modification',
lastUpdated: "Dernière modification",
algolia: {
apiKey: 'b1d88a4e2413821b4ebe7441ecc95a97',
indexName: 'health-data-hub-snds'
apiKey: "b1d88a4e2413821b4ebe7441ecc95a97",
indexName: "health-data-hub-snds"
},
smoothScroll: true
},
......@@ -60,10 +83,10 @@ module.exports = {
//toc: { includeLevel: [1, 2] },
extendMarkdown: md => {
// use more markdown-it plugins!
md.use(require('markdown-it-footnote'))
md.use(require("markdown-it-footnote"))
}
},
plugins: [
'mermaidjs'
"mermaidjs"
]
};
# A propos
<!-- SPDX-License-Identifier: MPL-2.0 -->
\ No newline at end of file
# Guide de contribution
<!-- SPDX-License-Identifier: MPL-2.0 -->
## 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](contribuer/Guide_utilisation_des_outils/Modifier_une_fiche.md), la [mise à jour](contribuer/Guide_utilisation_des_outils/Modifier_une_fiche.md) de certains champs, [compléter](contribuer/Guide_utilisation_des_outils/Modifier_une_fiche.md) des pages existantes, et en [créer de nouvelles](contribuer/Guide_utilisation_des_outils/Créer_une_fiche.md). 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 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).
### 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](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.
### Demande d’aide expertise SNDS
Si besoin est, les experts SNDS du Health Data Hub peuvent aider à la relecture :
- Anne Cuerq (ID gitlab: @INDS-AnneC),
- Emmanuel Stranadica (ID gitlab: @Emmanuel_S)
- Sinon contactez: << opensource.healt-data-hub.fr >>
### 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ée 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 )
## 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/).
### 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 :
- 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. 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.
test2
\ No newline at end of file
# Partage de documents existants/programmes
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 des documents existants dans votre organisation.
## Où publier des documents (hors programmes) ?
Vous avez deux options pour publier ces documents
- sur le site internet de votre organisation.
Ils seront référencé par un lien hypertexte dans la section [ressources externes](../../ressources/internet.md).
- 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é.
Une [fiche explicative](../../contribuer/Guide_utilisation_des_outils/partage_document.md) sur le partage de document est diponible sur le guide de contribution.
::: Tips
N'oubliez pas de renommer le fichier partagé. Le nom doit être sous la forme : Année-Mois-Jour_Organisation_nom-fichier_MLP-2.0.extension`
:::
## Partage de programmes
Le partage de programmes ou scripts d'analyses est très utile pour la communauté.
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). Les programmes partagés dans ce dépôt dédié sont sous licence APACHE 2.0.
Une [fiche]() sur les programmes partagés est diponible sur la documentation.
\ No newline at end of file
......@@ -3,7 +3,7 @@
L'essentiel du guide de contribution est résumé sous la forme de Cheat Sheet pour faciliter la contribution.
Une Cheat Sheet Markdown est [téléchargeable](../files/images/tutoriel_gitlab/2020-03-30_HDH_Cheatsheet-markdown_MLP-2.0.pdf).
Une Cheat Sheet Markdown est [téléchargeable](../../files/images/tutoriel_gitlab/2020-03-30_HDH_Cheatsheet-markdown_MLP-2.0.pdf).
<object data="../files/images/tutoriel_gitlab/2020-03-30_HDH_Cheatsheet-markdown_MLP-2.0.pdf" type="application/pdf" width="750px" height="750px">
<embed src="../files/images/tutoriel_gitlab/2020-03-30_HDH_Cheatsheet-markdown_MLP-2.0.pdf" type="application/pdf">
......
# Guide de contribution
<!-- SPDX-License-Identifier: MPL-2.0 -->
## 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]()
## Créer une fiche
### 1. Créer un Ticket
La première étape est la création d’un ticket. Se référer à la sous-partie correspondante. Créer un ticket permet d'informer la communauté qu'une nouvelle fiche va être créée. Cela permet d'éviter notamment les doublons.
### 2. Ajouter un fichier
### 3. Enregistrer les modifications apportées
### 4. Ouverture d'une demande de fusion (merge-request)
## Partager un programme
\ No newline at end of file
# Créer une fiche
<!-- SPDX-License-Identifier: MPL-2.0 -->
\ No newline at end of file
# Utilisation du Forum
<!-- SPDX-License-Identifier: MPL-2.0 -->
\ No newline at end of file
# Tickets
<!-- SPDX-License-Identifier: MPL-2.0 -->
Les tickets sont des outils de communications autour du projet de la documentation.
Ils peuvent être utilisés pour proposer un nouveau sujet de fiche, proposer des modifications dans une fiche, signaler une erreur, signaler un bug dans les outils.
Ils peuvent être attribués à une ou plusieurs personnes en désignant des assignés. Les tickets comportent une section commentaires, permettant de commencer une discussion avec les différents participants du ticket.
<p align="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_ticket_MLP-2.0.png" width="400px"/>
</p>
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
<p align="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_etiquette_MLP-2.0.png" width="400px"/>
</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.
<p align="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_ticket-liste_MLP-2.0.png" width="400px"/>
</p>
<p align="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_ticket-etiquette_MLP-2.0.png" width="400px"/>
</p>
### Créer un ticket
Pour créer un ticket : aller dans `Tickets` > `Nouveau ticket`.
Une fenêtre s'ouvre, permettant de décrire le ticket à créer.
1. Donner un titre
2. Faire une courte description
3. Vous assigner pour retrouver facilement votre ticket et assigner les personnes avec qui vous collaborez
4. Ajouter des étiquettes (label)
5. Enregistrer le ticket
<p align="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_creer-ticket_MLP-2.0.png" width="400px"/>
</p>
## Retrouver un ticket créé
Pour retrouver un ticket dans lequel on s'est assigné, il faut aller dans la barre de navigation de Gitlab et cliquer sur le bouton vert `Tickets` (cet onglet est juste à droite de la barre de recherche)
<p align="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_retrouver-ticket_MLP-2.0.png" width="400px"/>
</p>
## Naviguer dans le ticket créé
Une fois, le ticket validé, ce dernier comporte un titre, une description. Une liste des personnes assignées est disponible dans l'onglet à droite et est éditable en cliquant sur `éditer`. Il est également possible d'éditer les étiquettes. Une conversation peut démarrer en utilisant l'outils `commentaire` (le format markdown peut être utilisé lors d'édition de commentaires).
Chaque ticket comporte un numéro qui lui ait propre et qui permet de l'identifier. Il est possible de faire référence à un ticket dans une demande de fusion en indiquant `#numéro du ticket` en commentaire ou dans la description de la demande de fusion.
<p align="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_naviguer-ticket_MLP-2.0.png" width="400px"/>
</p>
# Naviguer dans le site de la documentation
<!-- SPDX-License-Identifier: MPL-2.0 -->
\ No newline at end of file
# Modifier la documentation des tables
<!-- SPDX-License-Identifier: MPL-2.0 -->
La section [Tables](../tables/README.md) de la documentation a un fonctionnement spécifique.
La section [Tables](../../tables/README.md) de la documentation a un fonctionnement spécifique.
Elle combine des **descriptions textuelles libres**, gérées comme le reste de la documentation, et des **informations structurées** issues du [schéma formel du SNDS](https://gitlab.com/healthdatahub/schema-snds).
Ce fonctionement est similaire à celui des pages wikipedia, où les informations structurées de wikidata sont gérées séparément du texte principal.
[![exemple wikidata](../files/images/contribution_tables/exemple_wikidata.png)](https://fr.wikipedia.org/wiki/Direction_de_la_Recherche,_des_%C3%89tudes,_de_l%27%C3%89valuation_et_des_Statistiques)
[![exemple wikidata](../../files/images/contribution_tables/exemple_wikidata.png)](https://fr.wikipedia.org/wiki/Direction_de_la_Recherche,_des_%C3%89tudes,_de_l%27%C3%89valuation_et_des_Statistiques)
## Modifier la description textuelle
......@@ -20,11 +20,11 @@ Le fichier source a 3 parties
1. **la description textuelle à éditer**, souvent vide actuellement ;
1. le code d'inclusion du schéma de la table, entouré de commentaires d'avertissement.
![](../files/images/contribution_tables/parties_fichier_source_tables.png)
![](../../files/images/contribution_tables/parties_fichier_source_tables.png)
*Exemple de fichier source de la documentation des tables*
::: tip
Si vous naviguez via le projet sur GitLab, ces fichiers sources sont dans le dossier [tables/.sources](../tables/.sources).
Si vous naviguez via le projet sur GitLab, ces fichiers sources sont dans le dossier [tables/.sources](../../tables/.sources).
:::
......@@ -40,14 +40,14 @@ Sur les pages de la section tables, un lien supplémentaire d'édition, situé s
/>
</p>
Ce schéma est stocké dans des fichiers json, selon le standard [table-schema](../glossaire/table-schema.md).
Ce schéma est stocké dans des fichiers json, selon le standard [table-schema](../../glossaire/table-schema.md).
![](../files/images/contribution_tables/exemple_modification_tableschema.png)
![](../../files/images/contribution_tables/exemple_modification_tableschema.png)
*Exemple de modification du schéma json*
À chaque modification du schéma, les fichiers markdown du dossier [tables/.schemas](../tables/.schemas) sont mis à jour automatiquement.
Ils sont ensuite combinés avec les fichiers correspondants du dossier [tables/.sources](../tables/.sources) pour mettre à jour la section [Tables](../tables/README.md).
À chaque modification du schéma, les fichiers markdown du dossier [tables/.schemas](../../tables/.schemas) sont mis à jour automatiquement.
Ils sont ensuite combinés avec les fichiers correspondants du dossier [tables/.sources](../../tables/.sources) pour mettre à jour la section [Tables](../../tables/README.md).
::: tip Note
Les modifications du schéma sont également propagées automatiquement sur le dictionnaire interactif et sur les données synthétiques.
......
......@@ -195,7 +195,7 @@ Première modification assez simple, au cours de laquelle on créée la branche
Il faut pour cela utiliser un chemin relatif, en utilisant un double point pour remonter d'un répertoire
Exemple : `[CMU-C](../fiches/cmu_c.md)` pour [CMU-C](../fiches/cmu_c.md)
Exemple : `[CMU-C](../fiches/cmu_c.md)` pour [CMU-C](../../fiches/cmu_c.md)
### Ajouter un fichier en téléchargement
......
# Ajouter une image dans une fiche
<!-- SPDX-License-Identifier: MPL-2.0 -->
\ No newline at end of file
......@@ -37,13 +37,13 @@ Lien vers url externe
### Liens internes
Lien vers document interne
[texte du lien](../glossaire/GHM.md)
[texte du lien](../../glossaire/GHM.md)
## Inclure des images
Pour afficher une image, ajouter un point d'exclamation devant son
chemin ou son URL.
![texte alternatif de l'image](../files/images/logo/logoSNDS.jpg)
![texte alternatif de l'image](../../files/images/logo/logoSNDS.jpg)
Utilisez des balises html, pour une image centrée et de largeur 100px fixée.
<p style="text-align:center;">
......
......@@ -34,7 +34,7 @@ Pour ajouter un nouveau fichier, merci de bien vouloir :
- Ajouter un lien de téléchargement sur une page
- Se placer sur la même branche
- Trouver le fichier où vous souhaitez mettre le lien
- sans doute une page de votre organisation dans la partie [Ressources](../ressources/README.md)
- sans doute une page de votre organisation dans la partie [Ressources](../../ressources/README.md)
- Mentionner le nom de l'organisation et la licence MPL-2.0.
......
# Partage de documents existants/programmes
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 des documents existants dans votre organisation.
## Où publier des documents hors programme ?
Vous avez deux options pour publier ces documents
- sur le site internet de votre organisation.
Ils seront référencé par un lien hypertexte dans la section [ressources externes](../ressources/internet.md).
- sur ce site de documentation.
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é.
Une [fiche explicative]() sur le partage de document est diponible sur le guide de contribution.
### Partage de programmes
Le partage de programmes ou scripts d'analyses est très utile pour la communauté.
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). Les programmes partagés dans ce dépôt dédié sont sous licence APACHE 2.0.
Une [fiche]() sur programme partagé est diponible sur le guide de contribution.
\ No newline at end of file
......@@ -124,7 +124,7 @@ Rappel : `../` remonte d'un cran dans l'arborescence, `../..` de deux crans etc.
```
[texte du lien](../glossaire/GHM.md)
```
Résultat : [texte du lien](../glossaire/GHM.md)
Résultat : [texte du lien](../../glossaire/GHM.md)
::: warning Lien vers tables
Les chemins des pages de description des tables ne sont pas faciles à trouver.
......@@ -143,7 +143,7 @@ Pour inclure une image, il faut tout d'abord la téléverser dans Gitlab (voir f
```
![texte alternatif de l'image](../files/images/logo/logoSNDS.jpg)
```
Résultat : ![texte alternatif de l'image](../files/images/logo/logoSNDS.jpg)
Résultat : ![texte alternatif de l'image](../../files/images/logo/logoSNDS.jpg)
2. Pour préciser les dimensions de l'image, il faut utiliser des balises html.
```
......@@ -164,7 +164,7 @@ Pour que ce texte soit **en dessous** de l'image, insérer deux espaces à la fi
```
Résultat :
![Editer sur Gitlab](../files/images/logo/logoSNDS.jpg)
![Editer sur Gitlab](../../files/images/logo/logoSNDS.jpg)
*Logo SNDS*
4. Pour centrer l'image, des balises html doivent également être utilisées :
......
......@@ -5,79 +5,4 @@ Bienvenue sur le guide de contribution !
Cette documentation est par nature collaborative.
## 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é.
Merci de se référer aux sections du guide correspondant aux différentes contributions possibles.
### 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).
### 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.
### 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).
### 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 )
## 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/).
### 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 :
- 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. 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/programmes
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 des documents existants dans votre organisation.
#### Où publier ces documents ?
Vous avez deux options pour publier ces documents
- sur le site internet de votre organisation.
Ils seront référencé par un lien hypertexte dans la section [ressources externes](../ressources/internet.md).
- sur ce site de documentation.
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é.
Une [fiche explicative]() sur le partage de document est diponible sur le guide de contribution.
### Partage de programmes
Le partage de programmes ou scripts d'analyses est très utile pour la communauté.
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). Les programmes partagés dans ce dépôt dédié sont sous licence APACHE 2.0.
Une [fiche]() sur programme partagé est diponible sur le guide de contribution.
Un [guide de contribution](contribuer/Guide_contribution) et un [guide d'utilisation](contribuer/Guide_utilisation_des_outils) des outils sont disponibles dans cette section `contribuer`.
\ No newline at end of file
This diff is collapsed.
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