Guide de contribution

Bienvenue sur le guide de contribution à la documentation !

Cette documentation est par nature collaborative, et toute contribution est bienvenue.

Cette page présente les grands types de contributions que vous pouvez apporter, et comment procéder. Les explications pratiques sont dans les pages suivantes.

Quelles contributions ?

Partage de documents existants

De nombreux organismes ont documenté le SNDS pour des besoins internes. Ce travail n'est souvent pas accessible à la communauté plus large des utilisateurs du SNDS. Une première contribution de grande valeur consiste à partager publiquement des documents existants.

Où publier ces documents ?

Note

Le nom de l'organisation sera indiqué dans la description du document, et dans le nom du fichier.

Une licence MPL-2.0 est appliquée sur tous les fichiers partagés via ce site.

Cette licence copyleft 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.

Amélioration des pages de documentation collaborative

Les contributions visant à corriger des erreurs ou à compléter des pages existantes sont très précieuses. Toute amélioration, même d'apparence mineure comme la correction de fautes d'orthographe, améliorera pour tous la qualité du contenu.

Création de nouvelles pages du site internet

La documentation du SNDS est éclatée dans de multiples fichiers, sous des formats hétérogènes : pdf, word, excel, powerpoint, etc. Cette disparité complexifie l'exploration des informations, et rend surtout impossible une collaboration large sur l'amélioration du contenu.

Ce site internet est rédigé à l'aide de fichiers textes type markdown. Un fichier markdown est balisé à l'aide de caractères spéciaux. Pour en savoir plus se référer au Tutoriel Markdown

Une excellente contribution consiste à créer de nouvelles pages de documentation, à partir de vos connaissances ou à partir du contenu de fichiers déjà partagés par ailleurs.

Nous organiserons progressivement les pages ainsi créées selon des thématiques cohérentes.

Comment contribuer ?

Cette section présente les principaux canaux de contribution.

Email

Le plus simple est d'écrire un email aux mainteneurs du projets :

Nous nous chargerons alors d'intégrer votre contribution.

Issues

En créant un compte sur gitlab.com, vous pourrez utiliser le système de tickets appelés issues, dans cet onglet.

Les issues sont le canal à privilégier pour remonter une erreur ou proposer une idée.
Chaque issue représente une opportunité de discussion ouverte pour résoudre le problème évoqué de manière collaborative. Tout le monde est en capacité d'y participer.

Merge-Request

GitLab permet à chacun de proposer des modifications via des merge-request, listées dans cet onglet.

Une formation est préférable pour manipuler facilement git, GitLab et les merge-request.

Les mainteneurs du projet organisent de telles formations (gratuites). N'hésitez pas à nous solliciter !