Merge branch 'docs' of gitlab.eox.at:esa/prism/vs into docs

README.md

@@ -217,8 +217,10 @@ make html
 # For watched html automatic building
 make html-watch
 
-# For pdf output run:
+# For pdf output
 make latexpdf
+# To shrink size of pdf
+gs -sDEVICE=pdfwrite -dPDFSETTINGS=/ebook -q -o iew-Server_-_User-Guide_small.pdf View-Server_-_User-Guide.pdf
 ```
 
 The documentation is generated in the respective *_build/html* directory.

documentation/operator-guide/intro.rst

@@ -3,12 +3,12 @@
 Introduction
 ============
 
-This guide will detail the operation of a View Server and all of its
+This guide details the operation of a View Server and all of its
 components.
 
 Since the View Server is a Docker based software and all of its components are
-distributed and executed in context of Docker images and containers, a
-knowledge of Docker and Docker Swarm is required.
+distributed and executed in context of Docker images and containers, basic
+knowledge of Docker and Docker Swarm is a prerequisite.
 
 Components
 ----------
@@ -18,7 +18,7 @@ respective Docker image in parenthesis):
 
  - Ingestor (ingestor)
  - Preprocessor (preprocessor)
- - Registrator (core)
+ - Registrar (core)
  - Renderer (core)
  - Cache (cache)
  - Seeder (cache)
@@ -34,11 +34,13 @@ Docker Images
 -------------
 
 The software is distributed as Docker images, which can be instantiated
-and run in their intended role. Some images are hosted on the docker hub,
+and run in their intended role. Some images are hosted on
+`docker hub <https://hub.docker.com/>`_,
 the official and default repository for Docker images. Other images reside
-on the gitlab.eox.at repository. Images from the official repository
-are only identified via their name, whereas images from the eox repository
-conventionally use the full URL, including the domain name.
+on an `EOX hosted registry <gitlab.eox.at>`_. Images from the official registry
+are only identified via their name, whereas images from the EOX registry
+conventionally use the full URL, including the domain name. Below is a list of
+the used images:
 
  - mdillon/postgis:10
  - redis
@@ -51,15 +53,15 @@ conventionally use the full URL, including the domain name.
 Configuration Files
 -------------------
 
-The following configuration files will impact the behavior of the View Server:
+The following configuration files impact the behavior of the View Server:
 
- - index.html: This is the main file to configure the client. In this file,
-    the viewing layer, search and download enpoints are configured. Usually
-    this is associated with additional backdrop and overlay layers.
- - preprocessor.yml: This file configures the preprocessing process.
- - mapcache.xml: This file defines the input sources of the cache and its
-    published layers.
- - init-db.sh: This file sets up the registrator and renderer side of the VS,
+ - `index.html`: This is the main file to configure the client. In this file,
+   the viewing layer, search and download endpoints are configured. Usually
+   this is associated with additional backdrop and overlay layers.
+ - `preprocessor.yml`: This file configures the preprocessing steps.
+ - `mapcache.xml`: This file defines the input sources of the cache and its
+   published layers.
+ - `init-db.sh`: This file sets up the registrar and renderer side of the VS.
 
 Setup
 -----

documentation/user-guide/web-client.rst

@@ -378,19 +378,29 @@ buttons on the right panel of the web client can be used.
    :alt: Web Client - Download multiple products via WCS
 
    *Web Client - Download multiple products via WCS*
-   
-Saving session
---------
-Web client allows to save some parts of its current state by setting the
-URL search parameters. That enables to revisit the same view in time and space later on or share the direct
-link with someone, overruling the default client setup. Please note that certain characters
-are automatically URL encoded, as URLs sent over the Internet only use ASCII character set.
-This means that if user manually enters for example **:** sign, while entering the website,
-it will automatically transform into **%3A**, making the url less readable.
-
-* Pre-set map position by setting **x**, **y** as parameters of the center of the map and zoom by **z** parameter. `Example of such query <https://vhr18.pdas.prism.eox.at?x=15&y=50&z=9>`_.
-* Time selection is set by `timestart` and `timeend`, and should be entered in as ISO 8601 UTC time format without milliseconds. `Example of such query <https://vhr18.pdas.prism.eox.at/?timestart=2017-12-31T17:32:45Z&timeend=2019-01-01T00:00:00Z>`_.
-* In case only one main layer is configured (like in the Emergency collection), additionally custom filters can be saved via their name. In order to investigate this option, the fastest way is to use the filter manually within the client and copy/modify the url parameters. `Example of such query <https://emg.pdas.prism.eox.at/?eo:cloudCover=0,50&geo:uid=urn:eop:EUSI:EW03:104005000FDC5200:058979092010>`_.
+
+Saving the session
+------------------
+
+The web client allows to save some parts of its current state by setting the
+URL search parameters. That enables users to revisit the same view in time and
+space later on or share the direct link with someone, overruling the default
+client setup. Please note that certain characters are automatically URL encoded,
+as URLs sent over the Internet only use the ASCII character set. This means that
+if user manually enters for example **:** sign, while entering the website,
+it will automatically transform into **%3A**, making the URL less readable.
+
+* Pre-set the map position by setting **x**, **y** as coordinates of the center
+  of the map and the zoom with the **z** parameter. `Map position example
+  <https://vhr18.pdas.prism.eox.at?x=15&y=50&z=9>`_.
+* The time selection is set by `timestart` and `timeend`, and should be entered
+  as ISO 8601 UTC time format without milliseconds. `Time selection example
+  <https://vhr18.pdas.prism.eox.at/?timestart=2017-12-31T17:32:45Z&timeend=2019-01-01T00:00:00Z>`_.
+* In case only one main layer is configured (like in the Emergency collection),
+  additionally custom filters can be saved via their name. In order to
+  investigate this option, the fastest way is to use the filter manually within
+  the client and copy/modify the URL parameters. `Filter example
+  <https://emg.pdas.prism.eox.at/?eo:cloudCover=0,50&geo:uid=urn:eop:EUSI:EW03:104005000FDC5200:058979092010>`_.
 
 The following chapters describe the services offered for :ref:`viewing`,
 :ref:`searching`, as well as :ref:`downloading`.