Développement documentation BQ

Sckende commented 6 months ago

Documentations existantes

Catégories de statut `à faire` `en cours` `à réviser` `terminé`	objectif	Responsable(s)
Penser à repo Literature - à fusionner avec Biodiversity_news (Vincent Beauregard) ?	`à faire`
Voir repo bdqc-dev-guidelines par Vincent	`à faire`
Voir repo fiches_synthese	@sckende	`terminé`
Voir readme du repo tableaurarefaction (archivé)	@sckende	`terminé`
Voir repo backup-tools	`à faire`
Voir repo rIO & io_db	`à faire`
Voir pour de la doc par TdeB ? Cf tableaulpi de Kath	@sckende	`terminé`
Voir docu Will bdqc-infrastructure (à updater)	@WilliamCabrera	`à faire`
Voir repo io-data à mettre à jour – envoi des données dans IO	@glaroc	`en cours`
Repo shiny_hooks_node à mettre à jour ?	`à faire`
Mettre à jour atlas_db	@BenMerSci	`terminé`

Documentations non existantes

objectif	Responsable(s)	Statut
Image de marque repo	@sckende	`à réviser`
Documenter où trouver les fonts/icones à l'image de BD --> cf repo	@sckende	`à réviser`
Documentation des tableaux de bord	@sckende	`en cours`
Repo SDM pipeline de Sarah ?	`à faire`
mapSPecies	@frousseu	`à faire`
Repo obs-datasets_gitlab – suivi des formatages des jeux de données injectés dans Atlas (archivé, migré vers repo `atlas-injection`)	@BenMerSci	`terminé`
Documentation stac-api-gateway	`à faire`
Stac-fastapi	`à faire`
stac-catalogue	`à faire`
sdmtools	@frousseu	`à faire`

TO DO

[ ] Cleaner/mettre à jour les liens des tableaux de bord/@sckende
[x] Voir avec Dom tableau sur les poissons (IFA data) --> archivé
[ ] Repo rapports_design - à organiser ? Voir avec @marie-pierre-varin pour centralisation de tous les rapports
[x] Repo tableaudelta -> demander à @vcameron1 si on archive
[x] Repo stage-Raphael-2023 -> géré par @BenMerSci lors de la phase de documentation (archived)
[x] @vcameron1 -> injection_notes à gérer
[x] Quel outil a utilisé pour centraliser la doc -> QUARTO
[x] Structuration du site -> cf diagramme (diagram.net)
[x] Ajouter dans le readme comment modifier le diagramme du site / @sckende
[ ] Protection de la doc qui sera privée
[x] ajout d'une catégorie "design" dans la structure de site pour image de marque et autres / @sckende - à réviser
[ ] ajout documentation de suivi par Anouk
[x] remplacer "analyses" par "recherche"
[x] retirer section "connexion à rweb"
[x] ajouter la liste des données injectées dans Atlas (sur portail Atlas ou dans la doc) @BenMerSci
[x] revision docs package gbif_insert @BenMerSci
[x] revision docs package ratlas @BenMerSci
[ ] section design - ajouter informations sur les icônes de coleo (tableaucoleoreact) @Sckende
[ ] section recherche - mettre les pipelines pour le calcul des indicateurs @vcameron1
[ ] section recherche - section à structurer @frousseu
[ ] section catalogue - lister le contenu de ACER et ajouter les métadata pour les buckets/couches dans ACER @glaroc @frousseu @Sckende
[ ] section serveur - à alimenter dont la partie webhook (urgent) @WilliamCabrera
[ ] section portail - ajouter liens vers "outils" endpoints atlas et coleo (atlas.biodiv....../api/v4) @glaroc ?
[ ] section portail -ajouter comment se connecter à coleo (cf ce qui est fait pour Atlas) @vcameron1
[ ] section portail - ajouter la doc pour strapi @WilliamCabrera
[ ] organiser la révision des différentes sections @Sckende

Liste de tableaux de bord non récupérée

[ ] Description_sites (responsable Claire)
[ ] adaptation (aux gradients de température, responsable Andrew)
[ ] atlas (explorateur Atlas, responsable François)
[ ] phénologie (responsable Andrew)

vcameron1 commented 5 months ago

La migration de injection_notes ne sera pas faite sur Coleo_db puisque le repo contenant les données brutes du ministère doit être privé. injection_notes l'est, mais pas Coleo_db

glaroc commented 5 months ago

@vcameron1 On peut le privatiser au besoin.

vcameron1 commented 5 months ago

@vcameron1 On peut le privatiser au besoin.

Done !

vincent-beauregard-ielab commented 1 month ago

Il y a des choses encore à faire ici ? On peut closer ?

Sckende commented 1 month ago

Aaaaah mais c'est une très bonne question ça !!! Je crois pas qu'on puisse closer. Faudrait repasser au travers pour un mise à jour de ce qu'il reste à faire. Et en passant, bon retour Vincent !!! :-D

BiodiversiteQuebec / bq_docs