Skip to content

Commit

Permalink
improve doc and theme
Browse files Browse the repository at this point in the history
  • Loading branch information
bruhnild committed Dec 11, 2024
1 parent 4c33d45 commit 5d1b85b
Show file tree
Hide file tree
Showing 6 changed files with 133 additions and 100 deletions.
182 changes: 104 additions & 78 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,112 +1,138 @@
**Geotrek**, *paths* management for *National Parks* and *Tourism organizations*.

.. image:: http://geotrek.fr/assets/img/logo.svg

:master: |master-status| |master-coverage| |master-e2e| |master-rtd|

.. |master-status| image::
https://github.com/GeotrekCE/Geotrek-admin/actions/workflows/test.yml/badge.svg
:alt: CI Status
:target: https://github.com/GeotrekCE/Geotrek-admin/actions/workflows/test.yml

.. |master-coverage| image::
https://codecov.io/gh/GeotrekCE/Geotrek-admin/branch/master/graph/badge.svg
:alt: Coverage
:target: https://codecov.io/gh/GeotrekCE/Geotrek-admin
Geotrek-admin
=============

.. raw:: html

<h1 align="center">Geotrek-admin</h1>

<p align="center"><img alt="geotrek admin image" src="/docs/_static/geotrek-admin.png"></p>

<p align="center">
<a href="https://geotrek.readthedocs.io/" rel="nofollow"><img alt="Documentation" src="https://img.shields.io/badge/Documentation-green.svg" style="max-width:100%;"></a>
<a href="https://demo-admin.geotrek.fr/" rel="nofollow"><img alt="Geotrek Admin demo" src="https://img.shields.io/badge/Demo-purple.svg" style="max-width:100%;"></a>
<a href="https://matrix.to/#/%23geotrek:matrix.org" rel="nofollow"><img alt="Chat Matrix" src="https://img.shields.io/badge/Chat-blue.svg" style="max-width:100%;"></a>
<a href="https://groups.google.com/g/geotrek-fr" rel="nofollow"><img alt="Forum Google Group" src="https://img.shields.io/badge/Forum-brightgreen.svg" style="max-width:100%;"></a>
</p>
<p align="center">
<a href="https://github.com/GeotrekCE/Geotrek-admin/actions/workflows/test.yml" rel="nofollow"><img alt="CI Status" src="https://github.com/GeotrekCE/Geotrek-admin/actions/workflows/test.yml/badge.svg" style="max-width:100%;"></a>
<a href="https://codecov.io/gh/GeotrekCE/Geotrek-admin" rel="nofollow"><img alt="Coverage" src="https://codecov.io/gh/GeotrekCE/Geotrek-admin/branch/master/graph/badge.svg" style="max-width:100%;"></a>
<a href="https://dashboard.cypress.io/projects/ktpy7v/runs" rel="nofollow"><img alt="End to End" src="https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/ktpy7v/master&style=flat&logo=cypress" style="max-width:100%;"></a>
<a href="https://geotrek.readthedocs.io" rel="nofollow"><img alt="Documentation" src="https://readthedocs.org/projects/geotrek/badge/?version=latest&style=flat" style="max-width:100%;"></a>
</p>

.. raw:: html

<p align="center">
<a href="#admin"><b>Admin</b></a> &#8226;
<a href="#features"><b>Features</b></a> &#8226;
<a href="#user-manual-french"><b>User manual</b></a> &#8226;
<a href="#installation-and-configuration"><b>Installation and configuration</b></a> &#8226;
</p>
<p align="center">
<a href="#support"><b>Support</b></a> &#8226;
<a href="#contribution"><b>Contribution</b></a> &#8226;
<a href="#thanks-to-all-contributors-"><b>Contributors</b></a> &#8226;
<a href="#license"><b>License</b></a> &#8226;
</p>

Admin
-----

**Geotrek-admin** is a web application designed to manage, centralize, and structure geographical and touristic information for your territory. It is the back-office application of the Geotrek ecosystem.

With Geotrek-admin, you can:

- Manage treks, touristic information, and related content (media, descriptions, etc.).
- Organize your data with maps, layers, and metadata.
- Export content to various public interfaces, such as Geotrek-rando or printed topoguides.

You can explore Geotrek-admin in action through our demonstration website:

- `https://demo-admin.geotrek.fr/ <https://demo-admin.geotrek.fr/>`_ (demo / demo)

Geotrek-admin is built on Django and leverages a PostGIS database for handling geographical data. It serves as the data source for Geotrek-rando, Geotrek-widget, and other tools of the Geotrek ecosystem.

Learn more about Geotrek-admin in the `general documentation (French) <https://geotrek.readthedocs.io/fr/latest/about/geotrek.html>`_.

Features
--------

.. |master-e2e| image::
https://img.shields.io/endpoint?url=https://dashboard.cypress.io/badge/simple/ktpy7v/master&style=flat&logo=cypress
:alt: End to End
:target: https://dashboard.cypress.io/projects/ktpy7v/runs
Geotrek-Admin is a powerful web mapping application designed for managing trekking, outdoor, and tourism data with ease. Tailored to support GIS features and extensive customization, it empowers organizations to manage, maintain, and publish their outdoor assets seamlessly:

.. |master-rtd| image::
https://readthedocs.org/projects/geotrek/badge/?version=latest&style=flat
:alt: Documentation
:target: https://geotrek.readthedocs.io
- **Management tool**: manage paths, interventions, signage, treks, POIs, touristic events, and much more.
- **Maintenance tracking**: track the maintenance of equipment and infrastructures with precision.
- **Advanced GIS capabilities**: control objects by district, protected areas, physical and legal status of paths, and compute 3D attributes using DEM draping.
- **Data synchronization**: interconnect with external platforms like Suricate, Apidae, and Tourinsoft for real-time data updates.
- **Publishing tools**:
- Create public websites with `Geotrek-rando <https://github.com/GeotrekCE/Geotrek-rando-v3>`_ (e.g., `Destination Écrins <https://rando.ecrins-parcnational.fr>`_, `Alpes Rando <https://alpesrando.net/>`_).
- Embed trek information into existing websites with `Geotrek-widget <https://github.com/GeotrekCE/Geotrek-rando-widget>`_ for flexible and lightweight integration (e.g., `Sidobre Vallée Tourisme <https://sidobre-vallees-tourisme.com/type_activite/balades-et-randonnees-sidobre-vallees/>`_, `la Toscane Occitane <https://www.la-toscane-occitane.com/a-voir-a-faire/balades-randonnees>`_).
- Develop mobile applications with `Geotrek-mobile <https://github.com/GeotrekCE/Geotrek-mobile>`_ (e.g., `Grand Carcassonne <https://play.google.com/store/apps/details?id=io.geotrek.grandcarcassonne>`_, `Jura outdoor <https://apps.apple.com/app/jura-outdoor/id6446137384>`_).
- **Customizable outputs**: export data in various formats (PDF, GPX, KML) for offline use and tailored user experiences.
- **Interactive mapping**: enable users to visualize and explore data-rich maps with detailed elevation profiles.
- **Documentation and support**: access comprehensive documentation, best practices, and community support for all your needs in the `official documentation <https://geotrek.readthedocs.io/en/2.111.0/usage/overview.html>`_.

Learn more on the `Geotrek product website <http://geotrek.fr>`_.

In brief
--------
User manual (french)
--------------------

* Web mapping application offering GIS features
* Manage paths, interventions, signage, treks, POIs, touristic events and so much more
* Track maintenance of equipments and infrastructures
* Control objets by district, protected areas, physical and legal status of paths
* Compute 3D attributes using DEM draping
* Allow to interconnect with multiple applications to synchronize data (Suricate, Apidae, Tourinsoft, etc.)
* Publish a public website with `Geotrek-rando <https://github.com/GeotrekCE/Geotrek-rando-v3>`_ (e.g. `PNE <https://rando.ecrins-parcnational.fr>`_, `PNM-PNAM <https://destination.marittimemercantour.eu/>`_)
* Publish a public mobile application with `Geotrek-mobile <https://github.com/GeotrekCE/Geotrek-mobile>`_ (e.g. `OTGC <https://play.google.com/store/apps/details?id=io.geotrek.grandcarcassonne>`_, `CD39 <https://apps.apple.com/app/jura-outdoor/id6446137384>`_)
- `Presentation <https://geotrek.readthedocs.io/fr/latest/usage/overview.html>`_
- `Management modules <https://geotrek.readthedocs.io/fr/latest/usage/management-modules.html>`_
- `Touristic modules <https://geotrek.readthedocs.io/fr/latest/usage/touristic-modules.html>`_

.. image:: http://geotrek.fr/assets/img/screen-1.png
Installation and configuration
------------------------------

More information on product website http://geotrek.fr
- `Installation <https://geotrek.readthedocs.io/fr/latest/install/installation.html>`_
- `Configuration <https://geotrek.readthedocs.io/fr/latest/install/configuration.html>`_
- `Advanced configuration <https://geotrek.readthedocs.io/fr/latest/install/advanced-configuration.html>`_

Documentation
-------------

* `User manual (in french) <https://geotrek.readthedocs.io/en/latest/usage/overview.html>`_
* `Installation and configuration instructions <http://geotrek.readthedocs.org>`_
* Help us translate `on Weblate <https://weblate.makina-corpus.net/>`_
Support
-------

- To report bugs or suggest features, please `submit a ticket <https://github.com/GeotrekCE/Geotrek-admin/issues>`_.
- Join our community to stay updated and share your experience! Connect on `Matrix <https://matrix.to/#/%23geotrek:matrix.org>`_ for real-time discussions, or connect through the `Google Group <https://groups.google.com/g/geotrek-fr>`_ to exchange ideas and insights.

Contribution
------------

* `Contributing guide <https://geotrek.readthedocs.io/en/latest/contribute/contributing.html>`_
* `Development documentation <https://geotrek.readthedocs.io/en/latest/contribute/development.html>`_
Interested in contributing? See our `Contributing Guide <https://geotrek.readthedocs.io/en/latest/contribute/contributing.html>`_. You can help in many ways, the ability to code is not necessary.

Thanks to all contributors ❤
----------------------------

.. image:: https://contrib.rocks/image?repo=GeotrekCE/Geotrek-admin
:target: https://github.com/GeotrekCE/Geotrek-admin/graphs/contributors

Made with `contrib.rocks <https://contrib.rocks>`_.

License
-------

* OpenSource - BSD
* Copyright (c) 2012-2023 - Makina Corpus / Parc national des Ecrins - Parc National du Mercantour - Parco delle Alpi Marittime
This project is under the MIT License. See the `LICENSE <Geotrek-admin/blob/main/LICENSE>`_ for details.

- OpenSource - BSD
- Copyright (c) 2012-2024 - Makina Corpus Territoires / Parc national des Ecrins - Parc National du Mercantour - Parco delle Alpi Marittime

.. image:: https://geotrek.fr/assets/img/logo_makina.svg
:alt: Logo MCT
:width: 115
:target: https://territoires.makina-corpus.com/
:width: 170

.. image:: https://geotrek.fr/assets/img/logo_autonomens-h120m.png
:target: https://datatheca.com
:alt: Logo Autonomens
:target: https://datatheca.com/

----

.. image:: http://geotrek.fr/assets/img/parc_ecrins.png
:alt: Parc des Ecrins
:target: http://www.ecrins-parcnational.fr


.. image:: http://geotrek.fr/assets/img/parc_mercantour.png
:alt: Parc du Mercantour
:target: http://www.mercantour.eu


.. image:: http://geotrek.fr/assets/img/alpi_maritime.png
:alt: Parco delle Alpi Marittime
:target: http://www.parcoalpimarittime.it


Status of sub-projects
----------------------

* |django-mapentity| `django-mapentity <https://github.com/makinacorpus/django-mapentity>`_
* |django-leaflet| `django-leaflet <https://github.com/makinacorpus/django-leaflet>`_
* |convertit| `ConvertIt <https://github.com/makinacorpus/convertit>`_
* |Leaflet.GeometryUtil| `Leaflet.GeometryUtil <https://github.com/makinacorpus/Leaflet.GeometryUtil>`_
* |Leaflet.FileLayer| `Leaflet.FileLayer <https://github.com/makinacorpus/Leaflet.FileLayer>`_
* |Leaflet.AlmostOver| `Leaflet.AlmostOver <https://github.com/makinacorpus/Leaflet.AlmostOver>`_

.. |django-mapentity| image:: https://github.com/makinacorpus/django-mapentity/actions/workflows/python-ci.yml/badge.svg
:target: https://github.com/makinacorpus/django-mapentity/actions/workflows/python-ci.yml

.. |django-leaflet| image:: https://github.com/makinacorpus/django-leaflet/actions/workflows/python-app.yml/badge.svg
:target: https://github.com/makinacorpus/django-leaflet/actions/workflows/python-app.yml

.. |convertit| image:: https://circleci.com/gh/makinacorpus/convertit.svg?style=shield
:target: https://circleci.com/gh/makinacorpus/convertit

.. |Leaflet.GeometryUtil| image:: https://travis-ci.org/makinacorpus/Leaflet.GeometryUtil.png?branch=master
:target: https://travis-ci.org/makinacorpus/Leaflet.GeometryUtil?branch=master

.. |Leaflet.FileLayer| image:: https://travis-ci.org/makinacorpus/Leaflet.FileLayer.png?branch=master
:target: https://travis-ci.org/makinacorpus/Leaflet.FileLayer?branch=master

.. |Leaflet.AlmostOver| image:: https://travis-ci.org/makinacorpus/Leaflet.GeometryUtil.png?branch=master
:target: https://travis-ci.org/makinacorpus/Leaflet.AlmostOver?branch=master
Binary file added docs/_static/geotrek-admin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 5 additions & 0 deletions docs/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ CHANGELOG
2.111.0+dev (XXXX-XX-XX)
----------------------------

**Documentation**

- Update theme color
- Fix typo in documentation
- Update and homogenize README.rst

2.111.0 (2024-12-05)
----------------------------
Expand Down
8 changes: 4 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,8 +60,8 @@
{
"media": "(prefers-color-scheme: light)",
"scheme": "default",
"primary": "green",
"accent": "light green",
"primary": "red",
"accent": "deep-orange",
"toggle": {
"icon": "material/weather-night",
"name": "Switch to dark mode",
Expand All @@ -70,8 +70,8 @@
{
"media": "(prefers-color-scheme: dark)",
"scheme": "slate",
"primary": "green",
"accent": "light green",
"primary": "red",
"accent": "deep-orange",
"toggle": {
"icon": "material/weather-sunny",
"name": "Switch to light mode",
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/apis.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ APIs externes
Geotrek et IGNrando'
--------------------

Geotrek-admin est capable de produire un flux des itinéraires et POIs présents dans sa BDD au format Cirkwi pour pouvoir les importer directement dans IGNrando' (https://makina-corpus.com/sig-webmapping/geotrek-et-lign-ca-fonctionne).
Geotrek-admin est capable de produire un flux des itinéraires et POIs présents dans sa BDD au format Cirkwi pour pouvoir les importer directement dans IGNrando' `(voir cet article) <https://makina-corpus.com/sig-webmapping/geotrek-et-lign-ca-fonctionne>`_.

Exemple des randonnées et POIs du Parc national des Ecrins publiées sur IGNrando' depuis Geotrek-admin : https://ignrando.fr/fr/communautes/parc-national-des-ecrins

Expand Down
36 changes: 19 additions & 17 deletions docs/usage/configuration-ttw.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,12 @@ Exemple : ajouter une étiquette
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Les étiquettes sont des encarts "pré-configurés" pouvant être réutilisés sur de multiples itinéraires. Elles présentent plusieurs avantages :

- ne pas avoir à saisir à chaque itinéraire les même informations
- permet de filtrer les itinéraires dans la vue liste (catégorie "Autres") sur Geotrek-Rando.

Pour les configurer, vous devez :

- vous rendre dans le module de configuration
- dans la section Étiquettes du groupe **COMMUN** cliquer sur :guilabel:`+ Ajouter`

Expand Down Expand Up @@ -285,7 +287,7 @@ Geotrek permet de configurer un ou plusieurs portails. Ce terme est utilisé pou

Ainsi, il est possible d'avoir plusieurs Geotrek-Rando branchés sur un seul Geotrek-Admin. Grâce à leur distinction sous forme de portail, il sera alors aisé de choisir sur quel Geotrek-Rando on souhaite faire apparaitre une information.

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).
Avec `Geotrek-widget <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 `(voir cet article) <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 le module de configuration sur la section "Portails cibles".

Expand Down Expand Up @@ -314,9 +316,9 @@ Intégration des fonds de cartes

Il est possible d'intégrer dans Geotrek différents fonds de carte comme :

* OpenStreetMap : https://www.openstreetmap.org/#map=6/46.449/2.210
* OpenTopoMap : https://opentopomap.org/#map=6.49.000/10.000
* ou les données IGN : https://geoservices.ign.fr/services-geoplateforme-diffusion
* `OpenStreetMap <https://www.openstreetmap.org/#map=6/46.449/2.210>`_
* `OpenTopoMap  <https://opentopomap.org/#map=6.49.000/10.000>`_
* `ou les données IGN  <https://geoservices.ign.fr/services-geoplateforme-diffusion>`_

Pour configurer l'ajout de fonds de plan, référez vous à cette section :ref:`Map settings <map-settings>`

Expand Down Expand Up @@ -345,16 +347,16 @@ Afin de s'intégrer au mieux dans le design standard, les couleurs suivantes son

Voici quelques ressources en ligne proposant des pictogrammes (sous licence libre) :

- `https://pictogrammers.com/library/mdi/ <https://pictogrammers.com/library/mdi/>`_
- `https://thenounproject.com/ <https://thenounproject.com/>`_
- `http://map-icons.com/ <http://map-icons.com/>`_
- `https://www.opensymbols.org/ <https://www.opensymbols.org/>`_
- `https://www.svgrepo.com/ <https://www.svgrepo.com/>`_
- `http://www.entypo.com/ <http://www.entypo.com/>`_
- `https://icons.getbootstrap.com/ <https://icons.getbootstrap.com/>`_
- `https://icongr.am/ <https://icongr.am/>`_
- `https://cocomaterial.com/ <https://cocomaterial.com/>`_
- `https://icofont.com/ <https://icofont.com/>`_
- `https://fontello.com/ <https://fontello.com/>`_
- `https://iconmonstr.com/ <https://iconmonstr.com/>`_
- `https://fontawesome.com/icons <https://fontawesome.com/icons>`_
- `Pictogrammers <https://pictogrammers.com/library/mdi/>`_
- `The Noun Project <https://thenounproject.com/>`_
- `Map icons <http://map-icons.com/>`_
- `Opensymbols <https://www.opensymbols.org/>`_
- `SVG repo <https://www.svgrepo.com/>`_
- `Entypo <http://www.entypo.com/>`_
- `Icons Getbootstrap <https://icons.getbootstrap.com/>`_
- `Icongr <https://icongr.am/>`_
- `Cocomaterial <https://cocomaterial.com/>`_
- `Icofont <https://icofont.com/>`_
- `Fontello <https://fontello.com/>`_
- `Iconmonstr <https://iconmonstr.com/>`_
- `Fontawesome <https://fontawesome.com/icons>`_

0 comments on commit 5d1b85b

Please sign in to comment.