Skip to content

Commit

Permalink
📝 [Improve] Minor improvements on documentation content
Browse files Browse the repository at this point in the history
  • Loading branch information
Bastien Potiron committed Jan 30, 2024
1 parent 788c673 commit e5742e8
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 18 deletions.
16 changes: 11 additions & 5 deletions docs/about/geotrek.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,23 +30,29 @@ C’est l’**application de référence** des parcs naturels, mais aussi de nom
Les quatre briques
==================

Geotrek dispose de quatre briques à la fois distincts et complémentaires :

La suite logicielle Geotrek dispose de quatre briques à la fois distincts et complémentaires :

* :ref:`Geotrek-admin <qu-est-ce-que-geotrek>`: outil de gestion et de saisie de l’ensemble des informations, intégrant les données des Systèmes d’Informations Touristiques (SIT) et pouvant être connecté à votre SIG ou à des systèmes d’information transport
* `Geotrek-rando <https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/docs/presentation-fr.md>`_ : site web, reprenant les informations saisies dans Geotrek-admin, à destination des internautes grand public
* `Geotrek-mobile <https://github.com/GeotrekCE/Geotrek-mobile#geotrek-mobile>`_ : application mobile fonctionnant sous Android et iOS, reprenant des informations saisies dans Geotrek-admin et optimisées pour l’usage mobile (volume, impact sur la batterie, hors-ligne, géolocalisation…)
* `Geotrek-rando-widget <https://github.com/GeotrekCE/Geotrek-rando-widget#geotrek-rando-widget>`_ : nouveau composant web permettant de valoriser une offre de contenus touristiques et de randonnées auprès des usagers du territoire, en l'intégrant dans un site internet existant

1.3 Utilisateurs
=================
.. note::
Cette documentation ne traite que de **Geotrek-Admin**, chaque brique ayant sa propre documentation.

Utilisateurs
============

L’application Geotrek, **destinée à deux types de public**, est une solution web qui apporte :

* des fonctionnalités de gestion des informations (itinéraires, sites outdoor, points d’intérêts, description, interprétation, médias…) et de gestion des infrastructures (signalétique, aménagements, travaux, réglementation…) pour les utilisateurs gérant un territoire (**Geotrek-admin**)
* des fonctionnalités simples et ludiques de recherche et de consultation d’itinéraires pour les internautes et les mobinautes (**Geotrek-rando V3**, **Geotrek-mobile** et **Geotrek-rando-widget**).

1.4 Composants libres
======================
Pour retrouver plus d'informations sur la suite applicative Geotrek, rendez-vous sur `geotrek.fr <https://geotrek.fr>`_.

Composants libres
=================

L’application Geotrek utilise les technologies open source suivantes :

Expand Down
24 changes: 15 additions & 9 deletions docs/contribute/design.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,7 @@ Architecture
Main components
---------------

The whole project is built on top of *mapentity*.


A generic application in charge of:
The whole project is built on top of *mapentity*, a generic application in charge of:

* Menus and models registry
* List/Detail/Create/Update/Delete views
Expand All @@ -44,12 +41,21 @@ Business specific notions are implemented in Geotrek-admin respective applicatio

* **common**: shared concepts between all applications (*Organism*, *utils*, ...)
* **authent**: groups, user, profile and structure notions. Optional external authent backend.
* **core**: elevation, paths, snapping, spatial referencing (topologies)
* **land**: static cities/districts/restricted areas layers, physical types, competence,
signage and work management
* **infrastructure**: buildings, signages, equipements
* **core**: paths, snapping, spatial referencing (topologies)
* **land**: physical types, competence, signage and work management
* **infrastructure**: buildings
* **signage**: signages and blades related content
* **maintenance**: interventions (on paths or on infrastructures) and projects
* **trekking**: POIs and treks
* **outdoor**: outdoor sites and courses
* **zoning**: static cities/districts/restricted areas layers
* **altimetry**: elevation, DEM
* **api**: manage all external communications interfaces (api v2, mobile)
* **cirkwi**: implementation of cirkwi related api
* **feedback**: feedbacks content, implementation of suricate workflow
* **flatpages**: flatpages models, used for publishing content on rando and mobile apps
* **sensitivity**: sensitive areas and species related content, link with Biodiv'Sport
* **tourism**: touristic contents and events, links with SIT (apidae, tourinsoft)


Django conventions twists
Expand All @@ -58,7 +64,7 @@ Django conventions twists
We have a couple of Django conventions infringements:

* SQL triggers everywhere: since Geotrek-admin database is to become the central storage
component of all park organisation data, it has to behave consistently whether data is
component of all territory organisation data, it has to behave consistently whether data is
modified through the Web application or raw access tools (pgadmin, QGIS).
(For example, insertion & update timestamps, geometry computation or DEM wrapping.)
* Safe delete: update field ``deleted = True`` instead of performing actual delete in table.
Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -247,7 +247,7 @@ Then run a synchronization.
Mapentity development
=====================

TODO
See `Django-Mapentity documentation <https://django-mapentity.readthedocs.io/>`_


UML diagrams of data model
Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/translating.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Release translations (only for github repository managers)
----------------------------------------------------------

Weblate send new translations to `translations` branch in Github, dedicated to translations.
When new translations chains are validated, manager has to send the manually to Github.
When new translations chains are validated, manager has to send them manually to Github.

For each release, `translations` branch must be merged into master before building the release.

Expand Down
2 changes: 0 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
Welcome to Geotrek's documentation!
===================================

.. _contents:

.. toctree::
:caption: 💡 About
:maxdepth: 2
Expand Down

0 comments on commit e5742e8

Please sign in to comment.