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

'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, lorien.benda@health-data-hub.fr, ID gitlab : @lbenda)
- Pierre-Alain Jachiet (Drees, pierre-alain.jachiet@sante.gouv.fr, ID gitlab : @pajachiet),
- Olivier de Fresnoye (HDH, olivier.defresnoye@health-data-hub.fr , ID gitlab : @ofrsn),
- Tim Vlaar (HDH, tim.vlaar@health-data-hub.fr, ID gitlab : @tim.vlaar),
- Salma El Oualydy (HDH, salma.eloualydy@health-data-hub.fr, ID gitlab : @salmael )
- Maeva Kos (HDH, maeva.kos@health-data-hub.fr, 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 <<opensource@health-data-hub.fr>>
- Lab santé - DREES <<ld-lab-github@sante.gouv.fr>>
## 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
# Guide de contribution
# Modifier une fiche
<!-- SPDX-License-Identifier: MPL-2.0 -->
**Sommaire**
[[_TOC_]]
## 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 un ticket
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.
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
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.
### Comment 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
### 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)
### 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.
## Modifier une fiche
### 1. Créer un Ticket
Avant de modifier directement une fiche, il est conseillé de créer avant tout un ticket.
## Créer un Ticket
Avant de modifier directement une fiche, il est conseillé de créer avant tout un [ticket](Guide_utilisation_des_outils/Ticket.md).
Si les modifications proposées sont jugées mineures (fautes d'orthographes, *etc.*) par le contributeur, l'étape de la création de ticket peut être sautée.
Si la modification est plus importante (ajout de code, d’un paragraphe, mise à jour etc.), il est utile de créer un ticket décrivant les modifications qui vont être apportées. Cela permet d'informer la communauté sur l'évolution du projet de documentation.
Si la modification est plus importante (ajout de code, d’un paragraphe, mise à jour etc.), il est utile de [créer un ticket](contribuer/Guide_utilisation_des_outils/Ticket.md) décrivant les modifications qui vont être apportées. Cela permet d'informer la communauté sur l'évolution du projet de documentation.
### 2. Ouvrir et éditer le fichier en mode édition
## Ouvrir et éditer le fichier en mode édition
Il y a deux manières d'éditer un fichier : en passant par le site de la documentation, ou en accédant à l'interface d'édition par Gitlab.
En bas de chaque page de la documentation se trouve un lien, vous invitant à éditer la fiche sur Gitlab. Ce lien redirige directement vers l'interface de Gitlab.
<p style="text-align:center;">
<img src="../files/images/tutoriel_gitlab/editer_sur_gitlab.png" alt="Éditer sur GitLab" width="200"/>
En [bas de chaque page de la documentation](contribuer/Guide_utilisation_des_outils/Utiliser_le_site_de_documentation.md) se trouve un lien, vous invitant à éditer la fiche sur Gitlab. Ce lien redirige directement vers l'interface de Gitlab.
<p style="center">
<img src="../../files/images/tutoriel_gitlab/editer_sur_gitlab.png" alt="Éditer sur GitLab" width="200"/>
</p>
La seconde option pour modifier une fiche est de trouver la fiche à modifier dans le dépôt sur Gitlab et d'ouvir l'interface d'édition avec le bouton `Editer`.
<p style="text-align:center;">
<img src="../files/images/tutoriel_gitlab/edition.png" alt="interface edition" width="600"/>
La seconde option pour modifier une fiche est de trouver la fiche à modifier dans le dépôt sur [Gitlab](https://gitlab.com/healthdatahub/documentation-snds/-/tree/master/fiches) et d'ouvir l'interface d'édition avec le bouton `Editer`.
<p style="center">
<img src="../../files/images/tutoriel_gitlab/edition.png" alt="interface edition" width="600"/>
</p>
Dans l'interface d'édition, il est possible de modifier le nom d'une fiche, modifier le texte en utilisant le format markdown.
......@@ -70,26 +32,30 @@ Dans l'interface d'édition, il est possible de modifier le nom d'une fiche, mod
- En cliquant sur `Aperçu`, une prévisualisation de la fiche peut être obtenue (certaines images peuvent ne pas s'afficher. Les blocs d'information étant des objets View Press, la prévisualisation ne pourra pas se faire.)
:::
Vous pouvez vous reporter aux fiches [inclure une image](), [Tutoriel Markdown]() pour aller plus loin.
Vous pouvez vous reporter aux fiches [inclure une image](contribuer/Guide_utilisation_des_outils/inclure_image.md), [tutoriel Markdown](contribuer/Guide_utilisation_des_outils/tutoriel_markdown.md) pour aller plus loin.
### 3. Enregistrer les modifications apportées
<p style="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_modifier-fiche_MLP-2.0.png" width="600"/>
</p>
## Enregistrer les modifications apportées
Un formulaire en bas de la page éditée permet d'enregistrer vos modifications dans un commit.
- Ecrivez un message décrivant les modifications apportées : une description courte, puis éventuellement une description plus longue séparée par une ligne vide.
- Choississez le nom d'une nouvelle branche de travail, **avec un nom explicite**. N'oubliez pas de remplacer les espaces par des tirets, sinon un message d'erreur s'affichera.
<p style="text-align:center;">
<img src="../files/images/tutoriel_gitlab/commit.png" alt="commit" width="600"/>
</p>
En bas de page, la case `créer une nouvelle demande de fusion` est automatiquement cochée. Laissez cette case cochée. Cela permettra une fois une fois les modifications enregistrées dans une branche cible, de demander à incorporer les modification effectuée dans la branche cible dans la branche master. Cela permettra également de discuter et valider les modifications apportées avant de les inclures dans la documentation.
- En bas de page, la case `créer une nouvelle demande de fusion` est automatiquement cochée. Laissez cette case cochée. Cela permettra une fois une fois les modifications enregistrées dans une branche cible, de demander à incorporer les modification effectuée dans la branche cible dans la branche master. Cela permettra également de discuter et valider les modifications apportées avant de les inclures dans la documentation.
- Cliquer sur `Commit Changes`
### 4. Ouverture d'une demande de fusion (merge-request)
Une page s'ouvre alors pour configurer cette merge-request.
<p style="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_modifier-fiche-enregistrer_MLP-2.0.png" alt="commit" width="600"/>
</p>
## Ouverture d'une demande de fusion (merge-request)
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]()
- Ajouter des assignés pour la [relecture et validation](contribuer/Guide_contribution/Contribuer_à_la_documentation.md)
- 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.
......@@ -100,10 +66,10 @@ Les demandes de fusions sont validées par certains membres de HDH.
:::
<p style="text-align:center;">
<img src="../files/images/tutoriel_gitlab/wip.png" alt="wip" width="600"/>
<img src="../../files/images/tutoriel_gitlab/wip.png" alt="wip" width="600"/>
</p>
### 5. Naviguer dans une demande de fusion (merge-request)
## Naviguer dans une demande de fusion (merge-request)
Lorsqu'une demande de fusion est créée, quatre onglets sous le titre de la demande de fusion permettent d'avoir une vue d'ensemble, avoir accès à l'historique des modifications, d'effectuer des tests sur la fiche, d'apporter de nouvelles modifications et comparer deux versions.
......@@ -134,7 +100,7 @@ Avant d’accepter une demande de fusion, ces tests sont toujours verifiés par
Lorsque la prévisualisation est construite, la deuxième icône passe au vert.
Cliquer dessus permet d'ouvrir la prévisalisation du site.
![prévisualisation](../files/images/tutoriel_gitlab/preview.png)
![prévisualisation](../../files/images/tutoriel_gitlab/preview.png)
À chaque nouveau commit sur la branche, le pipeline est relancé, et la prévisualisation est mise à jour avec la même url.
......@@ -148,10 +114,10 @@ Dans le menu déroulant `compare` il est possible de choisir quelles versions so
Le bouton Crayon `Edit File` permet d'apporter de nouvelles modifications (voir ci-dessous)
### 6. Retrouver sa demande de fusion
## Retrouver sa demande de fusion
Pour retrouver une demande de fusion dans lequel on s'est assigné, il faut aller dans la barre de navigation de Gitlab et cliquer sur le bouton orange `Demande de fusion`. Si on ne s'est pas assigné dans la demande de fusion, il faut aller dans l'onglet `Demande de fusion` dans la barre à gauche de l'interface Gitlab et chercher sa demande de fusion parmis la liste.
### 7. Apporter des modifications supplémentaires dans la même demande de fusion
## Apporter des modifications supplémentaires dans la même demande de fusion
Il existe deux méthodes pour apporter des modifications supplémentaires dans la même demande de fusion.
La première méthode consiste à ajouter des commits sur une branche de travail existante.
......@@ -163,7 +129,7 @@ Pour cela aller dans la barre présente à gauche de l'interface Gitlab. Aller d
La seconde méthode consiste à ouvrir sa demande de fusion. Dans l'onglet `Changes`, cliquer sur le bouton Crayon `Edit File`. Une fenêtre d'édition identique à celle lors de la première édition s'ouvre. Un nouveau commit décrivant les modifications apportées doit être enregistré. Il apparaitra dans l'historique des modifications dans la demande de fusion.
### 8. Suggérer des modifications
## Suggérer des modifications
Lors du [processus de relecture](), des modifications peuvent être suggérées par le relecteur.
* Soit en utilisant la boite de dialogue présente dans l'onglet `Vue d'ensemble` de la demande de fusion et en taguant la personne à qui les remarques sont adressées.
......@@ -173,17 +139,7 @@ Lors du [processus de relecture](), des modifications peuvent être suggérées
Pour taguer une personne il suffit de taper `@` et une liste déroulante des personnes participant au projet de la documentation apparait. En tapant le nom de la personne recherchée dans la barre de recherche on peut donc sélectionner la personne souhaitée.
:::
### 9. Incorporation des modifications dans le projet
## Incorporation des modifications dans le projet
Lorsque le [processus de relecture]() est terminée, les modification 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 et de pouvoir incorporer à la documentation les modifications proposées.
## 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
Cela permet aux mainteneurs du projet de savoir visuellement quelles demandes de fusion sont prêtes et de pouvoir incorporer à la documentation les modifications proposées.
\ 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.
......