Skip to content

Commit

Permalink
Update doc and fix RTFD images with absolute URL (#576)
Browse files Browse the repository at this point in the history
  • Loading branch information
camillemonchicourt authored Oct 30, 2024
1 parent 8964dde commit ea9434d
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 53 deletions.
9 changes: 5 additions & 4 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down
16 changes: 8 additions & 8 deletions docs/developpement.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"],
Expand All @@ -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) \
> <https://uicn.fr/wp-content/uploads/2018/04/guide-pratique-listes-rouges-regionales-especes-menacees.pdf> (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) \
> <https://uicn.fr/wp-content/uploads/2018/04/guide-pratique-listes-rouges-regionales-especes-menacees.pdf> (page 55)
3 changes: 0 additions & 3 deletions docs/images/detail-taxon.jpg

This file was deleted.

3 changes: 0 additions & 3 deletions docs/images/taxon-details.jpg

This file was deleted.

3 changes: 0 additions & 3 deletions docs/images/taxons-liste.jpg

This file was deleted.

3 changes: 0 additions & 3 deletions docs/images/taxref-liste.jpg

This file was deleted.

4 changes: 2 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Bienvenue dans la doc de TaxHub
manuel-utilisateur
manuel-administrateur
developpement
update_taxref_version
update-taxref-version
changelog

Contributeurs
Expand All @@ -18,4 +18,4 @@ Contributeurs
:limit: 100
:avatars:
:exclude: dependabot[bot]
:contributions:
:contributions:
4 changes: 1 addition & 3 deletions docs/manuel-administrateur.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 :
<https://github.com/PnX-SI/TaxHub/tree/master/apptax/taxonomie/commands/migrate_taxref>
<https://taxhub.readthedocs.io/fr/latest/update-taxref-version.html>

## Gestion des permissions

Expand Down
19 changes: 8 additions & 11 deletions docs/manuel-utilisateur.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,31 @@ 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
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

Expand All @@ -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.
Expand Down Expand Up @@ -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

Expand All @@ -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
Expand All @@ -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

Expand Down
29 changes: 16 additions & 13 deletions docs/update_taxref_version.md → docs/update-taxref-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.

Expand All @@ -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`.
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -191,12 +192,14 @@ sensibilité avec la version correspondant à la nouvelle version de
Taxref. Voir
<https://docs.geonature.fr/admin-manual.html#gestion-de-la-sensibilite>.

![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)
![image](https://media.githubusercontent.com/media/PnX-SI/TaxHub/master/docs/images/update-taxref-cas-4.jpg)

0 comments on commit ea9434d

Please sign in to comment.