📝 Add documentation portal / distance to source

docs/changelog.rst

@@ -2,6 +2,21 @@
 CHANGELOG
 =========
 
+
+1.1.1+dev    (XXXX-XX-XX)
+-------------------------
+
+**Documentation**
+
+* Add documentation portals
+* Add documentation distance to source
+
+**Enhancement**
+
+* Add informations when hub'eau does not send a json
+* Add migration generation distance to source
+
+
 1.1.0        (2023-13-06)
 -------------------------
 

docs/index.rst

@@ -14,6 +14,7 @@ It is a `Django <https://www.djangoproject.com/>`_ application, based on `Geotre
     usage/features
     usage/modules
     usage/configuration
+    usage/portals
     usage/import_data
 
 .. toctree::

docs/usage/configuration.rst

@@ -54,6 +54,11 @@ To customize lists for each module, go to django administration page.
     * Parameters
     * Station profiles
     * Units
+* Portal
+    * Portals
+    * Map base layers
+    * Group layers
+    * Layers
 * Proceeding: Event types
 * Studies Study types
 * Watershed

docs/usage/modules.rst

@@ -20,6 +20,20 @@ Streams
 
 Streams is a line with a source location and flow type. Length is computed from geometry.
 
+Distances to every objects is computed during the creation of an object and stocked in the table distancetosource.
+It's the distance of the shortest path between the object and the stream
+added with the length between the point of junction between the shortest path
+and the stream and the source location.
+
+If the source location is not at the start of the stream, we add also the distance of the shortest
+path between source location and the stream.
+
+
+
+.. image:: /images/distance_to_source.png
+    :alt: Object distance to source
+
+
 Descriptions
 ------------
 

docs/usage/portals.rst

@@ -0,0 +1,95 @@
+Valorization
+============
+
+To generate a good structure of your portal Georiviere, firstly you need to configurate in admin
+portals, map base layers, layers and groups.
+
+Portal
+------
+
+Fields :
+
+* Name
+* Web site
+* Title
+* Description
+* Main color
+* Min zoom on the map of your portal
+* Max zoom on the map of your portal
+* Spatial extent of your portal
+
+Map Base Layers
+---------------
+
+Map base layers are linked with one unique portal
+
+* Label
+* Url
+* Min zoom of this map base layer
+* Max zoom of this map base layer
+* Attribution
+* Portal
+* Order
+
+
+Layers
+------
+
+Layers are generated for each type of element you could add on your portal web site :
+
+* Contributions
+* Sensitivity
+* Districts
+* Cities
+* POIs (each category has it layer)
+* Streams
+* Watersheds
+
+Firstly, you need to create your portal before accessing layers.
+Then, you will be able to add them in a group of layer, change its labels...
+
+If you create a new category of poi, a new layer is generated.
+
+The fields of layers are :
+
+* Label
+* Group
+* Active by default
+* Style
+* Order
+* Hidden
+
+Style can be changed following the documentation of leaflet,
+for example:
+`{"fillColor": "#d4b485"}`
+
+(https://leafletjs.com/reference.html#path-stroke)
+
+When a layer is hidden, the layer is not used in the portal.
+
+The label is used in the portal and will be shown it.
+
+Groups
+------
+
+You can create as many group as you need and can add layers in the group.
+
+When a layer is not assigned to a group, the layer is groupped in a default group.
+
+The fields of groups are :
+
+* Label
+* Order
+
+---------------
+
+
+It's better to create everything in this order :
+
+* Create your portal
+* Create your base layers
+* Create the groups
+
+* Modify the generated layers
+
+