From ea9434de5a1f227131e0e8640ad17f8a25e8a39d Mon Sep 17 00:00:00 2001 From: Camille Monchicourt Date: Wed, 30 Oct 2024 10:15:47 +0100 Subject: [PATCH] Update doc and fix RTFD images with absolute URL (#576) --- docs/changelog.md | 9 +++--- docs/developpement.md | 16 +++++----- docs/images/detail-taxon.jpg | 3 -- docs/images/taxon-details.jpg | 3 -- docs/images/taxons-liste.jpg | 3 -- docs/images/taxref-liste.jpg | 3 -- docs/index.rst | 4 +-- docs/manuel-administrateur.md | 4 +-- docs/manuel-utilisateur.md | 19 +++++------- ...ef_version.md => update-taxref-version.md} | 29 ++++++++++--------- 10 files changed, 40 insertions(+), 53 deletions(-) delete mode 100644 docs/images/detail-taxon.jpg delete mode 100644 docs/images/taxon-details.jpg delete mode 100644 docs/images/taxons-liste.jpg delete mode 100644 docs/images/taxref-liste.jpg rename docs/{update_taxref_version.md => update-taxref-version.md} (90%) diff --git a/docs/changelog.md b/docs/changelog.md index a1d72a67..c013dcdf 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -3,13 +3,13 @@ 2.0.0 (2024-10-29) ------------------ -Refonte globale de l'interface de TaxHub avec Flask-admin, pour simplifier son développement et sa maintenance, mais aussi permettre de l'intégrer complètement dans le module "Admin" de GeoNature. -Si vous utilisez GeoNature, TaxHub sera désormais intégré à celui-ci dans le module "Admin" et il ne sera plus nécessaire de l'installer, l'administrer ni le mettre à jour indépendamment. -Compatibilité avec GeoNature 2.15.0 minimum. +- Refonte globale de l'interface de TaxHub avec Flask-admin, pour simplifier son développement et sa maintenance, mais aussi permettre de l'intégrer complètement dans le module "Admin" de GeoNature. +- Si vous utilisez GeoNature, TaxHub sera désormais intégré à celui-ci dans le module "Admin" et il ne sera plus nécessaire de l'installer, l'administrer ni le mettre à jour indépendamment. +- Compatibilité avec GeoNature 2.15.0 minimum. **🚀 Nouveautés** -- Refonte majeure de l'interface. Migration de Angular JS à Flask-Admin (#297, #377) +- Refonte majeure de l'interface. Migration de Angular JS à Flask-Admin (#297, #377, par @amandine-sahl, @TheoLechemia, @jacquesfize) - Suppression de la table `bib_noms`. Les attributs et médias sont désormais directement associés à la table `taxref`. Cela simplifie la gestion des taxons par les administrateurs, ainsi que la mise à jour régulière de Taxref (#111, #163) - Ajout d'une interface d'administration pour la création des types d'attributs et des thèmes - Peuplement en lot des listes de taxons avec un CSV de cd_nom (#299) @@ -25,6 +25,7 @@ Compatibilité avec GeoNature 2.15.0 minimum. - Evolution de la procédure de migration Taxref (#382) - Déplacement de la doc de mise à jour de Taxref dans la documentation générale de TaxHub (#555) - Dépreciation de la route `/taxoninfo` au profit de la route `/taxref` (#554) +- Ajout des propriétés optionnelles sur la route `/taxref` permettant de récupérer les attributs et les médias de chaque taxon (#498) - Ajout d'une route `/bdc_statuts/status_symbologies` renvoyant la symbologie de statuts des taxons (couleurs des valeurs des listes rouges) (#510, par @edelclaux) - Amélioration de la vue `taxonomie.vm_taxref_list_forautocomplete` pour afficher tous les noms d'un taxon (#332, par @JulienCorny et @andriacap) - Ajout d’une vue matérialisée `vm_taxref_tree` contenant pour chaque `cd_nom` la liste complète des `cd_ref` de ses taxons parents (#567, par @jbdesbas, @amandine-sahl, @bouttier) diff --git a/docs/developpement.md b/docs/developpement.md index 156641b6..35d0a6a6 100644 --- a/docs/developpement.md +++ b/docs/developpement.md @@ -51,11 +51,11 @@ - Params : - codes : filtre sur une liste de codes de types de statuts séparés par des virgules. - gatherings : filtre sur une liste de type de regroupement de types de statuts séparés par des virgules. -- `/bdc_statuts/status_symbologies` : Retourne les symbologies associées au statuts au format JSON. \ - Ces symbologies sont définies statiquement, au format suivant:\ +- `/bdc_statuts/status_symbologies` : Retourne les symbologies associées au statuts au format JSON. + Ces symbologies sont définies statiquement, au format suivant : -```json -{ + ```json + { "symbologies": [ { "types": ["LRM", "LRE", "LRN", "LRR"], @@ -74,8 +74,8 @@ }, } ] -} -``` + } + ``` -> Ces valeurs sont issues de la charte des codes couleurs pour les statuts Liste rouge, définis internationalement par l'Union internationale pour la conservation de la nature (UICN) \ -> (page 55) + > Ces valeurs sont issues de la charte des codes couleurs pour les statuts Liste rouge, définis internationalement par l'Union internationale pour la conservation de la nature (UICN) \ + > (page 55) diff --git a/docs/images/detail-taxon.jpg b/docs/images/detail-taxon.jpg deleted file mode 100644 index e2019884..00000000 --- a/docs/images/detail-taxon.jpg +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:9bbea500466aed8e323c55f883280e3a7c447298e7e0a6061e54d3007280f5b0 -size 66652 diff --git a/docs/images/taxon-details.jpg b/docs/images/taxon-details.jpg deleted file mode 100644 index 10ea2fd2..00000000 --- a/docs/images/taxon-details.jpg +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:7744be9d82e602d761726bd299c4f1e5e6527304a4f8d185be4fe28ed284ea84 -size 96126 diff --git a/docs/images/taxons-liste.jpg b/docs/images/taxons-liste.jpg deleted file mode 100644 index d2805ed1..00000000 --- a/docs/images/taxons-liste.jpg +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:fbf60f7cd60a2881b9c686584cc6aadfbd90bdbdbb96150e8ed38d8be577d63b -size 199462 diff --git a/docs/images/taxref-liste.jpg b/docs/images/taxref-liste.jpg deleted file mode 100644 index d03b255f..00000000 --- a/docs/images/taxref-liste.jpg +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:16f0761365eb13f204a4fe72284ce78216560af6896c030fb6151ccdb83f9657 -size 50154 diff --git a/docs/index.rst b/docs/index.rst index 51cef2a6..475ac5e3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,7 +8,7 @@ Bienvenue dans la doc de TaxHub manuel-utilisateur manuel-administrateur developpement - update_taxref_version + update-taxref-version changelog Contributeurs @@ -18,4 +18,4 @@ Contributeurs :limit: 100 :avatars: :exclude: dependabot[bot] - :contributions: \ No newline at end of file + :contributions: diff --git a/docs/manuel-administrateur.md b/docs/manuel-administrateur.md index 78e8e206..73b6a9cd 100644 --- a/docs/manuel-administrateur.md +++ b/docs/manuel-administrateur.md @@ -13,15 +13,13 @@ Pour spécifier les taxons à traiter la commande prend comme paramètre un fichier CSV contenant une liste de cd_nom -Des scripts d'intégration - ## Mise à jour de Taxref Un ensemble de commandes permettent de réaliser un changement de version de Taxref. La documentation détaillée est accessible ici : - + ## Gestion des permissions diff --git a/docs/manuel-utilisateur.md b/docs/manuel-utilisateur.md index f27b10c0..38f4ed8b 100644 --- a/docs/manuel-utilisateur.md +++ b/docs/manuel-utilisateur.md @@ -6,19 +6,19 @@ L'application TaxHub permet de gérer les informations liées à la taxonomie dans votre instance de GeoNature : espèces saisissables sur le module Occtax de GeoNature, informations diverses sur les espèces, enrichissement des fiches espèces de GeoNature-atlas, regroupement des -taxons en listes personnalisées etc. +taxons en listes personnalisées, etc. 3 onglets principaux structurent l'application : - **TAXREF** : Dans cet onglet, tout utilisateur connecté ou non peut explorer le référentiel taxonomique. Un utilisateur disposant des - permissions suffisantss pourra également ajouter des attributs ou médias à un taxon. + permissions suffisantes pourra également ajouter des attributs ou médias à un taxon. - **LISTES** : Cet onglet recense les listes disponibles et permet d'en créer des nouvelles, de les peupler, les modifier et les exporter. - **ATTRIBUTS** : Cet onglet recense les attributs disponibles et permet d'en créer de nouveaux. -## Exploration du Taxref +## Exploration de Taxref Dans l'onglet Taxref, vous pouvez explorer le référentiel national complet. Vous pouvez ainsi requêter selon différents champs et filtrer les résultats sur @@ -26,12 +26,11 @@ ces différentes colonnes, ou encore consulter les fiches espèces sur le site de l'INPN. Pour ces fonctions, il n'est pas nécessaire d'être connecté. -![image](images/explore_taxref.gif) +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/explore_taxref.gif) Cet onglet permet d'explorer le référentiel taxonomique national et de consultrer pour chaque taxon les attributs et médias de votre instance. -![image](images/detail_taxon.gif) - +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/detail_taxon.gif) ## Mettre à jour les informations d'un taxon @@ -49,7 +48,6 @@ pourrez associer un ou plusieurs médias à un taxon. Ces médias peuvent être des images, des vidéos, des enregistrements sonores, des fichiers PDF etc. - ## Créer et gérer des listes personnalisées TaxHub permet d'organiser les taxons au sein de listes personnalisées. @@ -78,7 +76,7 @@ insectes. Une fois la liste créée, vous pourrez la peupler ou l'exporter comme vu précédemment. -![image](images/create_use_lists.gif) +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/create_use_lists.gif) ## Créer et gérer des thèmes et attributs personnalisés @@ -98,7 +96,7 @@ entrée dans l'onglet "Thème". En créant cette entité, un ordre peut être donné au nouveau thème afin de les ordonner dans l'interface. -![image](images/create_theme.gif) +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/create_theme.gif) De la même manière, pour créer un attribut, il faut créer une nouvelle entrée dans l'onglet "Attribut"`. Il est alors possible de définir ses modalités possibles @@ -108,8 +106,7 @@ pour les listes, les attributs peuvent ou non être limités à un règne ou Votre application TaxHub est désormais dotée de nouveaux attributs ! -![image](images/create_attribut.gif) - +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/create_attribut.gif) ## Gérer le contenu de GeoNature-atlas diff --git a/docs/update_taxref_version.md b/docs/update-taxref-version.md similarity index 90% rename from docs/update_taxref_version.md rename to docs/update-taxref-version.md index 8a7b9cd5..73e705c1 100644 --- a/docs/update_taxref_version.md +++ b/docs/update-taxref-version.md @@ -7,7 +7,7 @@ A noter qu'il n'est pas nécessaire de migrer les versions de taxref une à une. Il est par exemple possible de passer directement de Taxref version 13 à 17. -## Avant de commencer : +## Avant de commencer - La migration d'une version de Taxref est une opération conséquente. Ce script permet d'automatiser au maximum les opérations, mais @@ -26,7 +26,8 @@ version 13 à 17. - Sinon le faire depuis GeoNature `(venv)$ geonature db autoupgrade` -## Migrer taxref +## Mettre à jour Taxref + Le passage vers une nouvelle version de Taxref se fait en 2 étapes, disponibles sous forme de commandes python. @@ -38,10 +39,10 @@ activer, il faut : # Activer le virtual env source venv/bin/activate -### Importer la nouvelle version de taxref +### Importer la nouvelle version de Taxref **import_taxref_vXX** : import de Taxref et détection des changements de -`bib_noms`. +`bib_noms` (avant TaxHub 2.0.0). Un export des changements est réalisé à l'issue du script, dans le fichier `liste_changements.csv`. @@ -53,10 +54,10 @@ Ce script réalise les opérations suivantes : - Analyse des données dans la Synthèse de GeoNature et identification de celles dont le cd_nom a disparu dans la nouvelle version de Taxref (listés dans le fichier `liste_cd_nom_disparus_synthese.csv`) -- Identification des cd_noms ayant disparu dans la table - `taxonomie.bib_noms` +- Identification des cd_noms ayant disparus dans la table + `taxonomie.bib_noms` (avant TaxHub 2.0.0) - Liste des cd_nom supprimés de `taxonomie.bib_noms` dans le fichier - `liste_cd_nom_disparus_bib_noms.csv` + `liste_cd_nom_disparus_bib_noms.csv` (avant TaxHub 2.0.0) - Détection et export des changements à venir dans le schéma temporaire `tmp_taxref_changes` et sa table `comp_grap` - Liste dans le fichier `liste_changements.csv` les changements qui @@ -161,7 +162,7 @@ pourrez relancer le script. remplacés et supprimés - Mise à jour des cd_ref de `taxonomie.bib_noms` en fonction des cd_noms, suppression des noms disparus, ajout des noms de références - manquants + manquants (avant TaxHub 2.0.0) - Répercussion des évolutions de Taxref sur les tables `taxonomie.t_medias` et `taxonomie.cor_taxon_attribut` en fonction des cas et actions définis dans la table @@ -191,12 +192,14 @@ sensibilité avec la version correspondant à la nouvelle version de Taxref. Voir . -![image](images/bdc_statut.png) +## MCD et cas de changements de taxons + +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/bdc_statut.png) -![image](images/update-taxref-cas-1.jpg) +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/update-taxref-cas-1.jpg) -![image](images/update-taxref-cas-2.jpg) +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/update-taxref-cas-2.jpg) -![image](images/update-taxref-cas-3.jpg) +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/update-taxref-cas-3.jpg) -![image](images/update-taxref-cas-4.jpg) \ No newline at end of file +![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/update-taxref-cas-4.jpg)