Ajout de l'inclusion des schémas des tables depuis un autre fichier
Utilisation du module markdown-include pour pouvoir inclure les schémas des tables dans le document indépendamment de la documentation globale de celles-ci.
Ainsi, les utilisateurs peuvent modifier la page de documentation sans que leur modifications soient écrasées, les schémas sont ajoutés avec le tag "#include".
Il existe 3 dossiers concernant la documentation des tables :
table/.schemas : contient les table-schemas .json (issus du schéma formel du SNDS), les schemas des tables au format .md sont générés à chaque build, grâce au module table-schema-to-markdown à partir des fichiers .json et de la template handlebars (.hbs) sous ".vuepress/"
tables/.sources : contient les fichiers avec le tag "#include" qui renvoient aux schemas correspondants sous "tables/.schemas", mais aussi à terme du texte libre décrivant les tables plus en détail, ces fichiers sont modifiables par les contributeurs (lien edit)
tables/ : contient le résultat final de la documentation, issu de la compilation des 2 précédents types de fichiers grâce au module markdown-include, ce sont les fichiers qui sont publiés sur le site et accessibles depuis la barre latérale (fichiers markdown non versionnés)
Nouveautés au niveau de la documentation des tables :
- Chaque table possède son propre permalink
- Affichage des clés étrangères
- Ajout d'un lien de navigation d'une table à l'autre quand il existe une référence entre elles
- Ajout d'un lien de modification du schéma de la table au format json (vers le repository https://gitlab.com/healthdatahub/schema-snds)
- Résolution de l'issue #9 du projet schema-snds concernant la description de l'unicité
- Résolution de l'issue #84 (closed) pour l'ordre alphabétique de la barre latérale
NB : les . au début de .schemas et .sources permettent de les ignorer pendant le build de Vuepress
NB2 : Il faudra ajouter la génération automatique d'un fichier .md sous le dossier ".sources" quand un nouveau schéma json est ajouté depuis schema-snds