Ce dépôt contient de la documentation sur la gestion des données de recherche (GDR) et est rédigé en utilisant le modèle Just the Docs.
Vous pouvez consulter cette documentation sur la GDR sous la forme d'un site Web agréable et lisible en vous rendant sur : documentation en ligne
Les compétences minimales nécessaires sur GitHub pour contribuer à la documentation se trouvent dans aide GitHub et branches GitHub. Vous pouvez synchroniser ce dépôt avec une version locale et y modifier les fichiers texte, puis pousser vos modifications vers le dépôt. Si vous souhaitez modifier les fichiers en local, vous devrez apprendre à utiliser GitHub Desktop.
Les contributions doivent être rédigées dans une branche ou un fork séparé (selon les droits d’accès de l’utilisateur). Une fois la documentation prête à être fusionnée, soumettez une demande de tirage ou DT (Pull Request ou PR) pour la fusionner avec la branche principale. L’examen et la fusion de la DT seront effectués par le responsable de la documentation.
Le contenu peut être édité directement dans le dépôt de Documentation en utilisant l'éditeur de texte intégré de GitHub. Comme Just the Docs est déjà déployé, tous ceux qui souhaitent contribuer n’ont pas besoin de redéployer Just the Docs ; les contributeurs peuvent simplement modifier les fichiers texte et les répertoires du dossier docs, qui stocke le contenu.
Pour rédiger du contenu, vous pouvez consulter les composants de l'interface de Just the Docs, en particulier la typographie (pour les titres), les tableaux, les listes et les encadrés.
La documentation est stockée dans le répertoire docs. Les sous-répertoires stockent les sujets parents/enfants (comme Documentation_Données). Les images sont stockées dans docs/assets/images.