Merge pull request #357 from GeotrekCE/doc-review-b

Doc review befire 3.0.0 release

README.md

@@ -1,6 +1,7 @@
 # Geotrek-rando V3
 
-Geotrek-rando is the public web application displaying the interface you can use to value your territory treks and tourism products!
+Geotrek-rando is the public web application displaying the interface you can use to value your territory treks and tourism products! 
+Demo available at https://gtr3.ecrins-parcnational.fr.
 
 The third version is a full redesign and rewriting of Geotrek-rando with React, and NextJS for Server side rendering (SSR) and SEO.
 

docs/changelog.md

@@ -1,11 +1,11 @@
 # Changelog
 
-3.0.0 (2021-04-16)
+3.0.0 (2021-04-29)
 ------------------
 
 * Full redesign and rewriting of Geotrek-rando with React and NextJS (for PWA, SSR and SEO)
 * Directly connected to Geotrek-admin API, no more using Geotrek-admin synchronization
-* Requires Geotrek-admin 2.53.1 minimun, reachable in https
+* Requires Geotrek-admin 2.57.0 minimun, reachable in https
 * Requires Docker to be installed
 
 **🚀 New features**

docs/customization.md

@@ -22,6 +22,7 @@ In json files, you can just override the primary keys you need. You have to over
   - `enableSensitiveAreas`: boolean, default to false. Set it to true if sensitive areas are defined in your Geotrek Admin.
   - `apiUrl` : Geotrek Admin API URL.
   - `googleAnalyticsId`: eventual Google Analytics Id.
+  - `google-site-verification`: eventual code to enable Google Search Console and Google developer tools.
   - `baseUrl`: base URL of your portal (for dynamic sitemap.xml).
   - `fallbackImageUri`: this uri is used to generate a default image for a trek or a touristic content if none is defined.
   - `touristicContentLabelImageUri` : this uri is used to define the logo of the labeled touristic contents:
@@ -45,8 +46,8 @@ In json files, you can just override the primary keys you need. You have to over
     - `shouldDisplayText`: `true` to display the text on above the asset, `false` to hide it.
 
 - `footer.json` to define social networks and links (based on translation labels) in footer (see example in hhttps://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/frontend/customization/config/footer.json)
-- `filter.json` to define filters to display, their order and values (see example in https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/frontend/customization/config/filter.json). If you remove some of the filters 
-- `map.json` to define basemaps URL and attributions, center (y, x) and default zoom (see example in https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/frontend/customization/config/map.json).
+- `filter.json` to define filters to display, their order and values (see example in https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/frontend/customization/config/filter.json). If you remove some of the filters in this file, they will not be displayed. If you want to override one filter, you have to list all others, otherwise they will not be displayed
+- `map.json` to define basemaps URL and attributions, center (y, x), default and max zoom level (see example in https://github.com/GeotrekCE/Geotrek-rando-v3/blob/main/frontend/customization/config/map.json).
 
   - You can also update the map layers. There are two map layers available:
 

docs/installation.md

@@ -11,7 +11,7 @@ Install Geotrek-rando on your own computer or server.
 Before starting the technical installation, here is an overview of the global process:
 - Developers are working on code source of this repository where you will also find the documentation, issues and releases
 - Once they have a new version of the application ready, they will release it, build a prebuild image of this new version and push it in the [packages repository](https://github.com/orgs/GeotrekCE/packages/container/package/geotrek-rando-v3%2Fgeotrek-rando-prebuild)
-- If required, they will also make changes to the dockerfile and customization template in the [dedicated repository](https://github.com/GeotrekCE/Geotrek-rando-v3-docker) and release a new version of it
+- If required, they will also make changes to the dockerfile and customization template in the [installer dedicated repository](https://github.com/GeotrekCE/Geotrek-rando-v3-installer) and release a new version of it
 - Administrators will log in on their host with SSH and install Docker on it
 - They will download an archive of the latest version of the Docker customization repository and extract it on their host
 - They will edit the customization files and build a customized image of the application
@@ -29,15 +29,15 @@ You need to have Docker installed on your own computer or server. Docker allows
 You will have to download the prebuilt default Docker image of Geotrek-rando and its customization folder template and build a customized image on your own computer or server.
 
 - Create a folder to install your Geotrek-rando (`/home/myuser/geotrekrando` for instance) and go in this folder
-- On your server download the [Geotrek-rando-docker repository](https://github.com/GeotrekCE/Geotrek-rando-v3-docker) version you want: `wget https://github.com/GeotrekCE/Geotrek-rando-v3-docker/archive/vX.Y.Z.zip` (replace `X.Y.Z` with the version of Geotrek-rando-v3-docker that is compatible with the Geotrek-rando-v3 version you want to use) and unzip it. You can also git clone it (`git pull https://github.com/GeotrekCE/Geotrek-rando-v3-docker.git`)
+- On your server download the [Geotrek-rando-installer repository](https://github.com/GeotrekCE/Geotrek-rando-v3-installer) version you want: `wget https://github.com/GeotrekCE/Geotrek-rando-v3-installer/archive/vX.Y.Z.zip` (replace `X.Y.Z` with the version of Geotrek-rando-v3-docker that is compatible with the Geotrek-rando-v3 version you want to use) and unzip it. You can also git clone it (`git pull https://github.com/GeotrekCE/Geotrek-rando-v3-installer.git`)
 - Update the files in the `/customization` folder according to your structure (See [customization](customization.md) documentation)
-- Go in the root folder of your Geotrek-rando-v3 docker and build a [specific version](https://github.com/orgs/GeotrekCE/packages/container/package/geotrek-rando-v3%2Fgeotrek-rando-prebuild) of the Docker image with `docker build -t geotrek-rando --build-arg VERSION={THE VERSION YOU WANT} .`
-- Now we want to run the website that we just built and make it available from your server adress. To do so run the docker image on the port you want: `docker run --restart unless-stopped -d -p {YOUR_PORT}:80 geotrek-rando`
+- Go in the root folder of your Geotrek-rando-v3-installer and build a [specific version](https://github.com/orgs/GeotrekCE/packages/container/package/geotrek-rando-v3%2Fgeotrek-rando-prebuild) of the Docker image with `docker build -t geotrek-rando --build-arg VERSION={THE VERSION YOU WANT} .`
+- Now we want to run the website that we just built and make it available from your server address. To do so run the Docker image on the port you want: `docker run --restart unless-stopped -d -p {YOUR_PORT}:80 geotrek-rando`
   - Let's explain what this command does step by step
     - `docker run [options] geotrek-rando` runs the container named geotrek-rando that we've just built
     - the `-d` option specifies that it should run "deamonized" meaning the container should run in background instead of keeping the terminal window linked to its stdout.
-    - the `-p` option specifies a port mapping between the port you want to connect on your machine to the port the server is running on in the docker container (here 80). Replace `{YOUR_PORT}` by any available port on your host.
-    ![Doker port maping](./assets/DockerPortMaping.png)
+    - the `-p` option specifies a port mapping between the port you want to connect on your machine to the port the server is running on in the Docker container (here 80). Replace `{YOUR_PORT}` by any available port on your host.
+    ![Doker port mapping](./assets/DockerPortMaping.png)
     - the `--restart unless-stopped` option specified that unless you stopped the container on purpose, it should restart automatically if something goes wrong.
 - Your website is now available to the address of your server