Merge pull request #77 from nens/origin/steven-docs

Origin/steven docs -> Updated viewer docs.

source/a_homepage.rst

@@ -3,7 +3,8 @@ Homepage
 ==========
 
 The Homepage ensures easy access to functionalities for all users.
-You can access the Lizard Homepage via the following url “www.{your_organisation}.lizard.net”.  This base url will also be referred to as 'Portal'. 
+You can access the Lizard Homepage via the following url “www.{your_organisation}.lizard.net”.
+This base url will also be referred to as 'Portal'. 
 Lizard works best in Chrome. No additional software is needed. 
 
 for example:
@@ -15,13 +16,13 @@ https://demo.lizard.net/
 From the Homepage, you can link to the Lizard functionality you are interested in.
 
 
-* **Catalogue** Search for your data. 
-* **Viewer** Explore your data.
-* **Management** Manage your data, users, alarms and GeoBlocks.
-* **API** Query your data.
+* **Catalogue**:  Search for your data. 
+* **Viewer**:     Explore your data.
+* **Management**: Manage your data, users, alarms and GeoBlocks.
+* **API**:        Query your data.
 
 
-There is also a link to support and the documentation. 
+From the homepage you have easy access to the support team and the documentation. 
 
 
 

source/a_lizard.rst

@@ -7,8 +7,11 @@ We enable you to unlock the potential of your data and allow you to integrate an
 Explore your data with plug-and-play applications.
 Or connect your favourite data science tools with our API. 
 
+The documentation has detailed descriptions of individual components of every aspect of Lizard.
+Feel free to move through every section in sequence by using the next functionality at the bottom of every page, or dive straight to the item of interest with the use of the left pane.
 
-The documentation will guide you through all the possibilities of Lizard.
-It contains step-by-step tutorials for users that want to explore their data using the Lizard Catalogue, Lizard Viewer and Lizard Atlases. 
-Data managers can find an extensive description for data exchange and management possibilities. 
-(Geo)data scientists can find interactive jupyter Notebooks with tutorials (in various levels of complexity) that explain how Lizard can be used in timeseries and geodata analysis. 
+To get familiar with the Catalogue or Viewer, use one of the following toturials:
+1. `Catalogue Tutorial <https://docs.lizard.net/e_catalog.html>` 
+2. `Viewer Tutorial <https://docs.lizard.net/e_viewer.html>`
+
+Tutorials in regards to the Lizard API usage can be found in the `API Tutorials section <https://docs.lizard.net/d_apitutorials.html>`

source/b_usermanagement.rst

@@ -48,20 +48,23 @@ Organisations
 
 All data in Lizard is linked to an organisation.
 Organisations are the backbone of our authorisation model.
+When an organisation uploads data, they are able to determine the level of authorisation required for access.
 There are three types of authorisation options that can be applied to your data: 
 
-* **Public**: everyone can see your data 
-* **Common**: everyone with login credentials to Lizard can see your data 
-* **Private**: everyone with login credentials to Lizard AND user rights to your organisation can see your data
+* **Public**: everyone is able to access your data 
+* **Common**: everyone with login credentials to Lizard is able to access your data 
+* **Private**: everyone with login credentials to Lizard AND user rights to your organisation is able to access your data
 
 
 
 Whitelisting
 ============
 
 The users of a certain portal may not be interested in a lot of the public/common datasets that are made available by others.
-An organisation can determine data of which other organisations is visible in their Lizard API and Viewer.
-This is configured by whitelisting the organisations that are allowed to show their data per portal.
+Every Lizard portal has its own whitelist.
+Whitelisting allows the organisations to determine which data should be visible.
+This can remove some of the clutter.
+The whitelist affects both the Lizard Viewer aswell as the Catalogue.
 
 The effect is that for the same user the available data can differ between [your_organisation].lizard.net and demo.lizard.net (for which all organisations are whitelisted).
 The whitelisting mechanism is overruled if a user has specific authorisation for an organisation.

source/c_wms.rst

@@ -1,28 +1,31 @@
 ===========
-Wms layers
+WMS Layers
 ===========
 
-WMS layers management allow to configure layers in Lizard even if they are hosted on another platform. In the management screen you can add new wms layers or edit existing layers.
+WMS stands for Web Mapping Service.
+It is a standard method of sharing georeferenced maps.
+The WMS layers management allows the user to configure layers in Lizard even if they are hosted on another platform.
+In the management screen you can add new WMS layers or edit existing layers.
 
 .. image:: /images/c_manage_wms_01.png
 
-New wms layer
+New WMS Layer
 ==============
 
 
 .. image:: /images/c_manage_newitem.png
 
-After clicking the 'new item' icon, you can configure a new wms layer. 
+After clicking the 'NEW ITEM' icon, you can configure a new WMS layer. 
 
 .. image:: /images/c_manage_wms_02.png
 
-The following fields can or must be filled in:
+The configuration has some mandatory items while others are optional, an extensive list with descriptions follows:
 
 1. GENERAL
 ------------
 
 * Name (required): Choose a name that is findable and not too difficult
-* Description (optional)
+* Description (optional): Give a description of the information that is displayed by the WMS layer.
 * Tags / Datasets (optional): You can connect the layer to an existing dataset. 
 
 2. DATA
@@ -49,14 +52,15 @@ The following fields can or must be filled in:
 If you are satisfied, click "SAVE"
 
 
-Edit wms layer
+Edit WMS Layer
 ===============
 
-After clicking on the name of a wms layer, you can configure an existing wms layer. If you can not find the wms layer, use the search bar, or change organisations. 
+By clicking on the name of a WMS layer, the configuration of the corresponding layer is opened.
+In the configuration page you can edit any of the settings previously given to the WMS layer.
+To quickly find a WMS layer: use the search bar.
+If the layer you are looking for seems unavailable you might have to switch organisations, feel free to contact the servicedesk for any problems (servicedesk@nelen-schuurmans.nl).
 
 .. image:: /images/c_manage_wms_03.png
 
-You can for example edit the description or share your wms layer with other organisations. 
-
 .. tip::
-	Advanced: Is your wms layer not visible in the Viewer? Check via the network tab (press F12) how Lizard requests the wms and if that wms url makes sense. You can always ask the service desk to help as well. 
+	Advanced: Is your WMS layer not visible in the Viewer? Check via the network tab (press F12) how Lizard requests the WMS and if that WMS url makes sense. 

source/d_apitutorials.rst

@@ -5,10 +5,17 @@ API tutorials
 We created interactive manuals for data scientists to use the Lizard API. 
 At the moment we have the following:
 
+0. Virtual Environment
+----------------------
+
+`Virtual Environment Requirements </files/tutorials/requirements.txt>`
+
+
 1. Interactive Time Series API manual 
 -------------------------------------
 
-| `Notebook for api/v4/timeseries <https://demo.lizard.net/media/tutorials/Getting_familiair_with_Lizard_Time_Series_API_V4.ipynb>`_
+| `Notebook for /api/v4/timeseries </files/tutorials/Lizard_Time_Series_API_V4_Tutorial.ipynb>`_
+
 
 2. Interactive Rasters API manual and download script
 -----------------------------------------------------
@@ -18,11 +25,10 @@ At the moment we have the following:
 | `Download script for /api/v4/rasters <https://demo.lizard.net/media/tutorials/export_lizard_raster_layers.py>`_
 
 
-3. 3Di scenario download
-------------------------
+3. Learn to retrieve scenarios from the Lizard API
 
-| `Notebook for how to download a maximum waterdepth raster from a 3Di-scenario <https://demo.lizard.net/media/tutorials/How_to_download_a_maximum_waterdepth_raster_from_a_3Di_scenario_stored_in_the_Scenario_Archive_in_Lizard_.ipynb>`_
+`Notebook for 3Di results / Scenarios in Lizard </file/tutorials/How_to_download_a_maximum_waterdepth_raster_from_a_3Di_scenario_stored_in_the_Scenario_Archive_in_Lizard_.ipynb>`
 
 
 .. note::
-	API v4 is the stable API version. API v3 is deprecated and is to be taken offline by 4 July 2023.
+	API v4 is the stable API version. API v3 is deprecated since june 2023.