Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Lizard docs v2 #95

Merged
merged 14 commits into from
Feb 22, 2024
4 changes: 3 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{
"restructuredtext.confPath": "${workspaceFolder}\\source"
"restructuredtext.confPath": "${workspaceFolder}\\source",
"iis.configDir": "",
"esbonio.sphinx.confDir": "${workspaceFolder}\\source"
}
2 changes: 1 addition & 1 deletion source/f_geoblocks.rst → source/a_geoblocks.rst
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ Geometry example: classify build year of buildings.
Geometry output
---------------

Geometry outputs are stored in :doc:`labels<c_labels>`.
Geometry outputs are stored in `labels <b_management.html#Labels>`_.
Labels are always linked to your Vectors stored in the Vector Server, for instance flood risk for parcels or buildings.
Labels are grouped in Labeltypes. The graph can be found via the labeltypes endpoint:

Expand Down
28 changes: 0 additions & 28 deletions source/a_homepage.rst

This file was deleted.

17 changes: 0 additions & 17 deletions source/a_lizard.rst

This file was deleted.

6 changes: 3 additions & 3 deletions source/d_apitutorials.rst → source/a_tutorials.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
==============================
=============
API tutorials
==============================
=============

We created interactive manuals for data scientists to use the Lizard API.
At the moment we have the following:

0. Virtual Environment
1. Virtual Environment
----------------------

| `Virtual Environment Requirements <https://demo.lizard.net/media/tutorials/requirements.txt>`_
Expand Down
51 changes: 51 additions & 0 deletions source/a_user_interfaces.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
===============
User interfaces
===============

Introduction
============

Lizard is a data and analytics platform, optimised for the physical environment.
We enable you to unlock the potential of your data and allow you to integrate and combine data from different sources and domains.
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.

Tutorials in regards to the Lizard API usage can be found in the `API Tutorials section <https://docs.lizard.net/a_tutorials.html>`

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'.
Lizard works best in Chrome. No additional software is needed.

for example:
https://demo.lizard.net/


.. image:: /images/a_homepage.jpg

From the Homepage, you can link to the Lizard functionality you are interested in.

* `**Catalogue** <b_catalogue>`_: Search for your data.
* `**Viewer** <b_viewer>`_: Explore your data.
* `**Management** <b_management>`_: Manage your data, users, alarms and GeoBlocks.
* `**API** <c_introduction>`_: Query your data.

From the homepage you have easy access to the support team and the documentation.


Catalogue
=============


Viewer
==========


Management
==========
11 changes: 8 additions & 3 deletions source/e_dashboard.rst → source/b_apps.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
=========
Dashboard
=========
====
Apps
====

This page contains an explanation of availibity of apps in Lizard!

Dashboards
==========

Manage, control and keep track with Lizard Dashboards.
Lizard Dashboards can offer key insights that help decision makers make data driven decisions.
Expand Down
10 changes: 5 additions & 5 deletions source/e_catalog.rst → source/b_catalogue.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ The following information is visible in this overview.
* **Access modifier** Divided into Public, Common and Private.

.. note::
Information about the different Access modifiers can be found under :ref:`OrganisationsAnchor`.
Information about the different access modifiers can be found under `organisation modifiers <d_authentication_user_management.html#Organisations>`_.

.. note::
Not included are rasters from 3Di scenarios
Expand Down Expand Up @@ -138,7 +138,7 @@ The following information is visible in this overview.
* **Access modifier** Divided into Public, Common and Private.

.. note::
Information about the different Access modifiers can be found under :ref:`OrganisationsAnchor`.
Information about the different access modifiers can be found under `organisation modifiers <d_authentication_user_management.html#Organisations>`_.

Details
--------
Expand All @@ -158,7 +158,7 @@ Action menu
You can download the wms directly, open it in the Viewer or in the API or analyse the wms layer in another application linking to Lizard.
You can use this link to visualise the raster in external applications such as QGIS or ESRI applications.

For more infomation, please consult the :doc:`WMS Services<e_lizardwms>`.
For more infomation, please consult the `WMS Services <b_management.html#WMS Services>`_.

Time series and monitoring networks
====================================
Expand All @@ -175,7 +175,7 @@ The following information is visible in this overview.
* **Access modifier** Divided into Public, Common and Private.

.. note::
Information about the different Access modifiers can be found under :ref:`OrganisationsAnchor`.
Information about the different access modifiers can be found under `organisation modifiers <d_authentication_user_management.html#Organisations>`_.

In monitoring networks, you can group timeseries. This can be done for example by grouping them by observation type or by source.

Expand Down Expand Up @@ -231,7 +231,7 @@ The following information is visible in this overview.
* **Access modifier** Divided into Public, Common and Private.

.. note::
Information about the different Access modifiers can be found under :ref:`OrganisationsAnchor`.
Information about the different access modifiers can be found under `organisation modifiers <d_authentication_user_management.html#Organisations>`_.


Details
Expand Down
File renamed without changes.
Loading
Loading