Commit f9ab34ab authored by Lorien Benda's avatar Lorien Benda

correction lien Readme tables, readme guide_contribution, update fiches...

correction lien Readme tables, readme guide_contribution, update fiches exercices_formation, Modifier_une_fiche, nouvelle_page, Readme Guide_utilisation_des_outils
parent 3a87dfc7
Pipeline #144564413 failed with stages
in 4 minutes and 51 seconds
......@@ -4,9 +4,9 @@
## 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 proposition d'amélioration, correction, modification via l'utilisation des [Tickets](../../contribuer/Guide_utilisation_des_outils/Ticket.md)
* la [améliorations, corrections et modifications](contribuer/Guide_utilisation_des_outils/Modifier_une_fiche.md),
* la [création de nouvelles fiches](contribuer/Guide_utilisation_des_outils/Créer_une_fiche.md).
* la proposition d'amélioration, correction, modification via l'utilisation des [Tickets](../contribuer/Guide_utilisation_des_outils/Ticket.md)
* la [améliorations, corrections et modifications](../Guide_utilisation_des_outils/Modifier_une_fiche.md),
* la [création de nouvelles fiches](../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é.
......@@ -20,7 +20,7 @@ Dès lors qu’une contribution est proposée comme ajout à la documentation da
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 : << opensource.healt-data-hub.fr >>
### Correction d’une contribution
Si une relecture appelle une [correction](../contribuer/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.
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:
......
# 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
......@@ -2,16 +2,16 @@
<!-- SPDX-License-Identifier: MPL-2.0 -->
## 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).
Avant de modifier directement une fiche, il est conseillé de créer avant tout un [ticket](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](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.
Si la modification est plus importante (ajout de code, d’un paragraphe, mise à jour etc.), il est utile de [créer un ticket](Ticket.md) décrivant les modifications qui vont être apportées. Cela permet d'informer la communauté sur l'évolution du projet de documentation.
## 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](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.
En [bas de chaque page de la documentation](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"/>
......@@ -32,7 +32,7 @@ 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](contribuer/Guide_utilisation_des_outils/inclure_image.md), [tutoriel Markdown](contribuer/Guide_utilisation_des_outils/tutoriel_markdown.md) pour aller plus loin.
Vous pouvez vous reporter aux fiches [inclure une image](inclure_image.md), [tutoriel Markdown](tutoriel_markdown.md) pour aller plus loin.
<p style="center">
<img src="../../files/images/tutoriel_gitlab/2020-04-27_HDH_modifier-fiche_MLP-2.0.png" width="600"/>
......@@ -60,7 +60,7 @@ Une page s'ouvre alors pour configurer la demande de fusion.
- Soumettre votre merge-request en bas de page.
::: Tips
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] 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](../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).
Les demandes de fusions sont validées par certains membres de HDH.
:::
......@@ -93,14 +93,16 @@ Lorsqu'une merge-request est ouverte, un "`pipeline`" est démarré pour effectu
Les tests permettent de vérifier que les liens externes et internes sont valides. Il y a également un test permettant de vérifier que l'identifiant de la licence est bien présent. En cas d’échec, des icônes oranges apparaissent pour les tests des lien externes et de la licence et une icône rouge apparaît pour le test des liens internes.
La [fiche]() reprenant les erreurs courantes rencontrées peut être utilisée pour corriger de manière autonome ces tests si le contributeur se sent à l'aise.
La [fiche](erreur_pipelines.md) reprenant les erreurs courantes rencontrées peut être utilisée pour corriger de manière autonome ces erreurs si le contributeur se sent à l'aise.
Avant d’accepter une demande de fusion, ces tests sont toujours verifiés par les mainteneurs et les corrections nécessaires sont apportées en cas d’échec.
Lorsque la prévisualisation est construite, la deuxième icône passe au vert.
Cliquer dessus permet d'ouvrir la prévisalisation du site.
Cliquer dessus, permet d'ouvrir la prévisualisation du site.
![prévisualisation](../../files/images/tutoriel_gitlab/preview.png)
<p style="text-align:center;">
<img src="../../files/images/tutoriel_gitlab/preview.png" alt="wip" width="600"/>
</p>
À chaque nouveau commit sur la branche, le pipeline est relancé, et la prévisualisation est mise à jour avec la même url.
......@@ -114,8 +116,12 @@ 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)
<p style="text-align:center;">
<img src="../../files/images/tutoriel_gitlab/2020-05-10_HDH_MR-comparaison_MLP-2.0.png" alt="wip" width="600"/>
</p>
## 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.
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 parmi la liste.
## 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.
......@@ -129,17 +135,25 @@ 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.
<p style="text-align:center;">
<img src="../../files/images/tutoriel_gitlab/2020-05-10_HDH_edit-file_MLP-2.0.png" alt="changer branche" width="400"/>
</p>
## Suggérer des modifications
Lors du [processus de relecture](), des modifications peuvent être suggérées par le relecteur.
Lors du [processus de relecture](../Guide_contribution/README.md), 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.
* Soit en faisant un commentaire ou une proposition de modification sur une ligne spécifique. Pour cela, aller dans l'onglet `Changes` de la demande de fusion, et passer la souris sur la ligne à commenter/modifier. Un bouton bleu contenant une bulle de conversation apparait à gauche. En le sélectionnant il est possible d'écrire un commentaire spécifique à la ligne sélectionnée. Une suggestion de modification peut être insérée à partir de la fenêtre des commentaires en cliquant sur le bouton `Insert Suggestion`. Cela fera apparaitre une suggestion de modification dans l'onglet `Vue d'ensemble` de la demande de fusion. Celle-ci pourra être acceptée ou refusée par l'auteur de la fiche.
<p style="text-align:center;">
<img src="../../files/images/tutoriel_gitlab/2020-05-10_HDH_proposer-correction_MLP-2.0.png" alt="changer branche" width="400"/>
</p>
::: Tips
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.
:::
## 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'.
Lorsque le [processus de relecture](../Guide_contribution/README.md) 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.
\ No newline at end of file
......@@ -4,3 +4,42 @@
## 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é 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="200"/>
</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]() 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](Créer_une_fiche.md)
- Comment rajouter une [image](inclure_image.md) dans une fiche
- Comment [partager un document](partage_document.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
### 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 visiblité. 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 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](Créer_une_fiche.md)
- en partageant des [programmes](../../contribuer/Guide_contribution/partager_des_sources.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="200"/>
</p>
\ No newline at end of file
......@@ -11,7 +11,7 @@ Le support de formation ci-dessous peut être ouvert en [suivant ce lien](http:/
<div class="responsive-wrap">
<p style="text-align:center;">
<iframe
src="https://docs.google.com/presentation/d/1oYQksP4GwsWrbSBlJcMukk-jlx7YUM7NEmz4_kCUrCA/embed?start=false&loop=false&delayms=1000"
src="https://docs.google.com/presentation/d/1m9DZh37TShLuZ5d1PBtxe1nv5XN92v5_WRZpe_iKeck/edit#slide=id.g732b02f83a_2_75"
frameborder="0" width="700" height="430"
allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"
></iframe>
......
......@@ -20,7 +20,7 @@ Enregistrez votre fichier, avec un nom
- sans espace, pour simplifier les liens internes ;
- terminer par l'extention **.md**, pour indiquer qu'il s'agit d'un fichier Markdown.
Pour la suite, enregistrez votre modification dans une branche et ouvrez une merge-request de la même façon que pour modifier un fichier (cf [Introduction GitLab](introduction_gitlab.md)).
Pour la suite, enregistrez votre modification dans une branche et ouvrez une merge-request de la même façon que pour modifier un fichier (cf [Introduction GitLab](Introduction_Gitlab.md)).
## Créer un nouveau dossier
Pour créer un nouveau dossier, naviguer dans le dossier de votre choix, et sélectionnez **Nouveau dossier** dans le menu déroulant `+`.
......
......@@ -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_utilisation_des_outils/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