📝 [Documentation] Renomage Admin site to Configuration module

GeotrekCE · Feb 28, 2024 · 22917c4 · 22917c4
1 parent 90933b2
commit 22917c4
Show file tree

Hide file tree

Showing 9 changed files with 29 additions and 24 deletions.
diff --git a/docs/about/geotrek.rst b/docs/about/geotrek.rst
@@ -56,7 +56,7 @@ Composants libres
 
 L’application Geotrek utilise les technologies open source suivantes :
 
-* **Python / Django**, l'épine dorsale de l'application qui prend en charge les principales fonctionnalités comme l'interface de configuration, l'exploitation de la base de données, la gestion des utilisateurs et de leurs droits ou l'intégration avec les bibliothèques cartographiques. La richesse de son écosystème permet de concevoir des applications aux possibilités infinies, en favorisant la production d'applications sécurisées, solides (tests automatiques) et robustes (Python).
+* **Python / Django**, l'épine dorsale de l'application qui prend en charge les principales fonctionnalités comme le module de configuration, l'exploitation de la base de données, la gestion des utilisateurs et de leurs droits ou l'intégration avec les bibliothèques cartographiques. La richesse de son écosystème permet de concevoir des applications aux possibilités infinies, en favorisant la production d'applications sécurisées, solides (tests automatiques) et robustes (Python).
 * **PostgreSQL / PostGIS** pour la base de données. La totalité des données de l'application est stockée dans une instance PostgreSQL avec l'extension spatiale PostGIS :
 
   * attributs, comptes utilisateurs…,

diff --git a/docs/install/advanced-configuration.rst b/docs/install/advanced-configuration.rst
@@ -1158,7 +1158,7 @@ Use timers to receive alerts for your reports
 
 **To enable the alerts :**
 
-- Go to the Admin Site and set "Timer days" to some integer other than 0 in relevant statuses (`/admin/feedback/reportstatus/`)
+- Go to the Configuration module and set "Timer days" to some integer other than 0 in relevant statuses (`/admin/feedback/reportstatus/`)
 
 - Select the "Uses timers" checkbox on reports that you wish to receive alerts for (in report update form)
 

diff --git a/docs/others/changelog.rst b/docs/others/changelog.rst
@@ -9,6 +9,10 @@ CHANGELOG
 
 - Add `include_externals` filter to Cirkwi trek exports, to allow excluding treks with an external id (eid) (#3947)
 
+**Documentation**
+
+- Reorganize major sections in documentation, and add content
+
 
 2.102.1 (2024-02-20)
 --------------------
@@ -32,8 +36,6 @@ CHANGELOG
 **Documentation**
 
 - Improve performance in spatial intersection (zoning district and zoning city) for sql views (#3600)
-- Improve documentation with new sections (about, touristic modules)
-
 
 **New features**
 

diff --git a/docs/usage/apis.rst b/docs/usage/apis.rst
@@ -44,24 +44,27 @@ Il est possible d'exclure les POI du flux pour ne diffuser que les randonnées.
 Il est possible de filtrer les POI du flux par structure. Pour cela, ajouter le paramètre ``?structures=<identifiant_de_la_structure>`` à la fin de l'URL (``http://XXXXX/api/cirkwi/pois.xml?structures=2``).
 Vous pouvez filtrer avec plusieurs structures : en séparant les identifiants par des virgules (``http://XXXXX/api/cirkwi/pois.xml?structures=2,5,3``).
 
-Il est également possible de filtrer les randonnées du flux par structure et par portail. Pour cela, ajouter le paramètre ``?structures=<identifiant_de_la_structure>``.
-ou ``?portals=<identifian_de_la_structure>`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?portals=3``).
-Tout comme les pois Vous pouvez filtrer avec plusieurs structures et portails : en séparant les identifiants par des virgules.
+Il est également possible de filtrer les randonnées du flux par structure et par portail. 
+Pour cela, ajouter le paramètre ``?structures=<identifiant_de_la_structure>`` ou ``?portals=<identifian_de_la_structure>`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?portals=3``).
 
 Il est également possible d'exclure du flux les randonnées provenant de sources externes à Geotrek-Admin. Ce filtre est notamment nécessaire pour
 ne pas renvoyer à Cirkwi les randonnées qui en proviennent déjà. Pour cela, ajouter le paramètre ``?include_externals=false`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?include_externals=false``).
 
 Il est possible de cumuler ces différents filtres, en séparant les valeurs par un ``&`` (``http://XXXXX/api/cirkwi/circuits.xml?portals=3&structures=1&include_externals=false``).
 
-Le référentiel CIRKWI a été intégré dans 3 tables accessibles dans l'interface de configuration Django (à ne pas modifier) :
+Il est également possible d'exclure du flux les randonnées provenant de sources externes à Geotrek-Admin. Ce filtre est notamment nécessaire pour ne pas renvoyer à Cirkwi les randonnées qui en proviennent déjà. Pour cela, ajouter le paramètre ``?include_externals=false`` à la fin de l'URL (``http://XXXXX/api/cirkwi/circuits.xml?include_externals=false``).
+
+Il est possible de cumuler ces différents filtres, en séparant les valeurs par un ``&`` (``http://XXXXX/api/cirkwi/circuits.xml?portals=3&structures=1&include_externals=false``).
+
+Le référentiel CIRKWI a été intégré dans 3 tables accessibles dans le module de configuration (à ne pas modifier) :
 
 .. figure:: ../images/user-manual/cirkwi-tables.png
    :alt: Ensemble des champs paramétrables pour le référentiel CIRKWI
    :align: center
 
    Ensemble des champs paramétrables pour le référentiel CIRKWI
 
-Si vous ne souhaitez pas utiliser les valeurs par défaut ou avez créez vos propres typologies, il faut que vous renseigniez les correspondances entre les catégories de votre Geotrek et celles du référentiel IGN (Cirkwi) dans votre interface de configuration Django. Comme indiqué ici : https://github.com/GeotrekCE/Geotrek-admin/issues/806.
+Si vous ne souhaitez pas utiliser les valeurs par défaut ou avez créez vos propres typologies, il faut que vous renseigniez les correspondances entre les catégories de votre Geotrek et celles du référentiel IGN (Cirkwi) dans le module de configuration. Comme indiqué ici : https://github.com/GeotrekCE/Geotrek-admin/issues/806.
 
 * Pratique >> locomotion/loisirs
 * Accessibilite >> thematiques/tags

diff --git a/docs/usage/configuration-ttw.rst b/docs/usage/configuration-ttw.rst
@@ -13,10 +13,10 @@ Accès interface de configuration
 Menu à droite > admin
 
 .. figure:: ../images/admin/capture-admin.png
-   :alt: Lien vers l'interface de configuration Django
+   :alt: Lien vers le module de configuration
    :align: center
 
-   Lien vers l'interface de configuration Django
+   Lien vers le module de configuration
 
 .. _parametrages-des-modules:
 
@@ -37,7 +37,7 @@ Itinéraires
 Exemple : ajouter une pratique
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
--  Dans l'interface de configuration Django, à la ligne “Pratiques” cliquer sur “+ ajouter”
+-  Dans le module de configuration, à la ligne “Pratiques” cliquer sur “+ ajouter”
 -  Remplir les champs (en gras les champs obligatoires)
 
 .. note::
@@ -57,7 +57,7 @@ Les étiquettes sont des encarts "pré-configurés" pouvant être réutilisés s
 - permet de filtrer les itinéraires dans la vue liste (catégorie "Autres") sur Geotrek-Rando.
 
 Pour les configurer, vous devez :
-- vous rendre dans l'interface de configuration Django
+- vous rendre dans le module de configuration
 - dans la section Étiquettes du groupe **COMMUN** cliquer sur :guilabel:`+ Ajouter`
 
 Via cette interface vous pourrez créer des étiquettes puis, une fois créées, les rattacher à des itinéraires.
@@ -146,7 +146,7 @@ Les utilisateurs appartiennent à des groupes et les permissions peuvent être a
 
 Avec les groupes, vous pouvez créer et configurer un profil utilisateur, chacun possédant des permissions spécifiques.
 
-Toute la configuration des utilisateurs, groupes et permissions est disponible depuis l'interface de configuration Django, si vous n'avez pas activé *Authentification externe* (voir ci-dessous).
+Toute la configuration des utilisateurs, groupes et permissions est disponible depuis le module de configuration, si vous n'avez pas activé *Authentification externe* (voir ci-dessous).
 
 .. figure:: ../images/admin/django-admin-params-users.png
    :alt: Interface de configuration des utilisateurs/groupes
@@ -178,7 +178,7 @@ Un utilisateur donné peut avoir trois niveaux permissions basiques :
 .. note::
   Il est préférable de désactiver un compte lorsqu’un utilisateur n’intervient plus sur Geotrek, plutôt que de le supprimer. En effet supprimer le compte supprimera également par exemple toutes les entrées dans l’historique de Geotrek associées à ce compte.
 
-- **Équipe** : si la case est cochée l’utilisateur pourra accéder à l’interface de configuration Django de Geotrek-Admin
+- **Équipe** : si la case est cochée l’utilisateur pourra accéder au module de configuration de Geotrek-Admin
 
 - **Super-utilisateur** : permet d’octroyer toutes les permissions à un utilisateur sans avoir à les définir explicitement
 
@@ -204,7 +204,7 @@ Chaque type de donnée est au moins associée à ces quatres actions de base (*a
 
 Voici la signification des actions autorisées dans les permissions :
 
-* *view* : voir les données dans l’interface AdminSite de Django (pour ledonnées dans « category », comme les types de POI, ou les niveaux de difficulté)
+* *view* : voir les données dans le module de configuration (pour ledonnées dans « category », comme les types de POI, ou les niveaux de difficulté)
 * *read* : voir les données dans Geotrek-admin (détail et liste)
 * *add* : ajouter une nouvelle donnée (itinéraire, thème…)
 * *change* : modifier une donnée
@@ -286,7 +286,7 @@ Ainsi, il est possible d'avoir plusieurs Geotrek-Rando branchés sur un seul Geo
 
 Avec le widget Geotrek (https://github.com/GeotrekCE/geotrek-rando-widget) il est également possible d'utiliser cette fonctionnalité pour distinguer les contenus à afficher dans un widget ou dans un autre (https://makina-corpus.com/logiciel-libre/developpement-geotrek-widget-finance-parc-naturel-regional-haut-jura).
 
-Pour configurer un ou pluseurs portails, il faut se rendre dans l'interface de configuration Django sur la section "Portails cibles".
+Pour configurer un ou pluseurs portails, il faut se rendre dans le module de configuration sur la section "Portails cibles".
 
 .. figure:: ../images/admin/portals.png
    :alt: Configuration des portails

diff --git a/docs/usage/editing-objects.rst b/docs/usage/editing-objects.rst
@@ -19,7 +19,7 @@ Tous les objets linéaires reposant sur les tronçons récupèrent leurs informa
 Calcul du dénivelé
 ---------------------
 
-Nous calculons le « dénivelé positif cumulé <https://fr.wikipedia.org/wiki/D%C3%A9nivel%C3%A9_positif_cumul%C3%A9>`_.
+Nous calculons le `dénivelé positif cumulé <https://fr.wikipedia.org/wiki/D%C3%A9nivel%C3%A9_positif_cumul%C3%A9>`_.
 
 Nous échantillonnons le DEM tous les 25m par défaut (voir paramètre ``ALTIMETRIC_PROFILE_PRECISION``),
 et nous ajoutons un peu de lissage pour éviter le bruit.

diff --git a/docs/usage/interfaces.rst b/docs/usage/interfaces.rst
@@ -79,13 +79,13 @@ Vue édition
 Paramètres de configuration
 ============================
 
-Toutes les listes de choix (thématiques, pratiques, parcours…) sont administrables depuis l'outil d'administration Django, selon les droits dont dispose l’utilisateur connecté.
+Toutes les listes de choix (thématiques, pratiques, parcours…) sont administrables depuis le module de configuration, selon les droits dont dispose l’utilisateur connecté.
 
 .. figure:: ../images/admin/interface-django.png
-   :alt: Interface complète de configuration Django
+   :alt: Interface complète du module de configuration
    :align: center
 
-   Interface complète de configuration Django
+   Interface complète du module de configuration
 
 .. figure:: ../images/user-manual/django-pratique.png
    :alt: Exemple d’édition des pratiques et de leur pictogramme

diff --git a/docs/usage/static-pages.rst b/docs/usage/static-pages.rst
@@ -19,14 +19,14 @@ Les pages statiques sont les pages d'information et de contextualisation de votr
 
 Elles permettent de fournir à l'internaute et futur randonneur des informations génériques : présentation de votre structure, votre projet de randonnée, recommandations, informations pratiques, etc.
 
-Elles sont gérées depuis l'interface de configuration Django de Geotrek-admin et sont ensuite publiées sur Geotrek-rando à chaque synchronisation du contenu. 
+Elles sont gérées depuis le module de configuration de Geotrek-admin et sont ensuite publiées sur Geotrek-rando à chaque synchronisation du contenu. 
 
 .. image :: /images/user-manual/flatpages-adminsite.jpg
 
 Créer une page statique
 ========================
 
-Depuis l'interface de configuration Django de Geotrek-admin, sélectionnez "Pages statiques" dans la rubrique "Flatpages".
+Depuis le module de configuration de Geotrek-admin, sélectionnez "Pages statiques" dans la rubrique "Flatpages".
 
 .. image :: /images/user-manual/flatpages-flatpages.png
 

diff --git a/docs/usage/touristic-modules.rst b/docs/usage/touristic-modules.rst
@@ -401,7 +401,7 @@ Ordre des catégories
 
 Dans le portail Geotrek-rando, les différents types de contenus sont éclatés en catégories.
 
-Pour définir leur ordre d'affichage, il est possible de le définir dans la base de données pour certains contenus (ordre des pratiques des itinéraires et des catégories de contenus touristiques) en renseignant leur champs ``ordre`` depuis l'interface de configuration Django de Geotrek-admin.
+Pour définir leur ordre d'affichage, il est possible de le définir dans la base de données pour certains contenus (ordre des pratiques des itinéraires et des catégories de contenus touristiques) en renseignant leur champs ``ordre`` depuis le module de configuration de Geotrek-admin.
 
 Zone tampon pour contenus à proximité
 ----------------------------------------