Commit 3a87dfc7 authored by Lorien Benda's avatar Lorien Benda

ajout partie guide_contribution et mise à jour Readme table, readme initial

parent 26f2e0ec
Pipeline #144112989 failed with stages
in 5 minutes
......@@ -22,7 +22,7 @@ Elle résulte d'une mise en commun de documents et travaux par plusieurs organis
[DREES](https://drees.solidarites-sante.gouv.fr/etudes-et-statistiques/la-drees/)
- les Agences régionales de santé - [ARS](https://www.ars.sante.fr/)
- Santé publique France - [SpF](https://www.santepubliquefrance.fr/)
- Organisation de la direction de la sécurité sociale - [DSS](https://solidarites-sante.gouv.fr/ministere/organisation/organisation-des-directions-et-services/article/organisation-de-la-direction-de-la-securite-sociale-dss)
## Organisation
......
# A propos
<!-- SPDX-License-Identifier: MPL-2.0 -->
\ No newline at end of file
<!-- SPDX-License-Identifier: MPL-2.0 -->
## Historique
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 d' 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
## Auteurs
La documentation étant collaborative, différents [auteurs/mainteneurs](https://gitlab.com/healthdatahub/documentation-snds/-/graphs/master) participent au projet.
## Citation
Merci de citer ce site si vous l'utilisez dans vos travaux.
::: tip Citation au format recommandé par l'APA
> Documentation collaborative du SNDS. (n.d.). Retrieved from https://gitlab.com/healthdatahub/documentation-snds
:::
## Licences
La documentation est publiée par le Health data hub sous licence Mozilla Public License 2.0 (MPL-2.0)
Un fichier licence est disponible sur Gitalb: [LICENSE](https://gitlab.com/healthdatahub/documentation-snds/blob/master/LICENSE).
Les programmes partagés sur le dépôt [Programme sur Gitlab](https://gitlab.com/healthdatahub/programmes-sdns) sont publiés sous licence [APACHE-2.0](https://www.apache.org/licenses/LICENSE-2.0).
## Partenaires
La documentation résulte d'une mise en commun de documents et travaux par plusieurs organisations, dont :
- la Caisse nationale d'assurance maladie - [Cnam](https://www.ameli.fr/)
- le Health Data Hub - [HDH](https://www.health-data-hub.fr)
- la Direction de la Recherche, des études, de l’évaluation et des statistiques -
[DREES](https://drees.solidarites-sante.gouv.fr/etudes-et-statistiques/la-drees/)
- les Agences régionales de santé - [ARS](https://www.ars.sante.fr/)
- Santé publique France - [SpF](https://www.santepubliquefrance.fr/)
- Organisation de la direction de la sécurité sociale - [DSS](https://solidarites-sante.gouv.fr/ministere/organisation/organisation-des-directions-et-services/article/organisation-de-la-direction-de-la-securite-sociale-dss)
## Contact
Pour toutes questions, suggestions, vous pouvez nous contactez par mail : << [email protected] >>
......@@ -3,7 +3,12 @@
## 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é.
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).
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).
......@@ -12,13 +17,10 @@ Chaque contribution à la documentation est soumise à une relecture par les pai
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 >>
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
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.
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.
### 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:
......@@ -48,5 +50,5 @@ La maîtrise de gitlab et la rédaction au format markdown sont des prérequis n
### 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 meetup 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
# Contactez-nous
<!-- SPDX-License-Identifier: MPL-2.0 -->
Pour toutes questions sur la documentation, signalements d'erreurs, ou pour demander de l'aide dans le partage de documents et publication de fiches, vous pouvez nous contacter sur cette adresse : <<[email protected]>>
\ No newline at end of file
# Partage de documents existants/programmes
<!-- SPDX-License-Identifier: MPL-2.0 -->
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.
......@@ -7,11 +8,13 @@ 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. 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](../../ressources)
- 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
......@@ -23,6 +26,4 @@ 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
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](../../ressources/programmes.md) les repertoriant est disponible sur le site de la documentation.
\ No newline at end of file
# 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.
......@@ -7,19 +7,17 @@ Une contribution de grande valeur consiste donc à partager publiquement des doc
Vous avez deux options pour publier ces documents
- sur le site internet de votre organisation.
Ils seront référencé par un lien hypertexte dans la section [ressources externes](../ressources/internet.md).
Ils seront référencé par un lien hypertexte dans la section [ressources externes](../../ressources/internet.md).
- sur ce site de documentation.
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é.
[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.
Une [fiche explicative](../../contribuer/Guide_utilisation_des_outils/partage_document.md) sur le partage de document est disponible 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
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](../../ressources/programmes.md) les repertoriant est disponible sur le site de la documentation.
\ No newline at end of file
......@@ -5,4 +5,6 @@ Bienvenue sur le guide de contribution !
Cette documentation est par nature collaborative.
Un [guide de contribution](Guide_contribution/README.md) et un [guide d'utilisation](Guide_utilisation_des_outils/README.md) des outils sont disponibles dans cette section `contribuer`.
\ No newline at end of file
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`.
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
......@@ -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/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