Merge pull request #350 from mundialis/tutorial_update

Actinia Tutorials Update
actinia-org · May 25, 2022 · 21b85d9 · 21b85d9
2 parents f605d43 + 04776e6
commit 21b85d9
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 12 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+## Depoly
+* cd to actinia_core/docs/ folder
+* run the command `mkdocs gh-deploy`
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -17,16 +17,26 @@ example all Landsat 4-8 scenes as well as all Sentinel-2 scenes in an
 ephemeral databases. The computational results of ephemeral processing
 are available via object storage as GeoTIFF files.
 
-The full API documentation is available here:
+The full API documentation is available here: <https://actinia.mundialis.de/api_docs/>
 
- <https://actinia.mundialis.de/api_docs/>
-
-::: {.toctree maxdepth="2"}
-Introduction \<introduction\> Introduction \<actinia\_concepts\>
-Installation \<installation\> Actinia database access
-\<tutorial\_data\_access\> Time-series sampling
-\<tutorial\_strds\_sampling\> Landsat NDVI computation
-\<tutorial\_landsat\_ndvi\> Sentinel-2A NDVI computation
-\<tutorial\_sentinel2a\_ndvi\> User defined processing
-\<tutorial\_process\_chain\> License \<license\> Authors \<authors\>
-:::
+* Introduction
+    * What is REST?
+    * Examples
+    * Actinia REST API documentation
+    * User, user-roles and user-groups
+    * The Actinia databases 
+* Installation
+* Actinia database access
+    * Using curl for HTTP requests 
+    * Access to locations and mapsets in the persistent database 
+    * Access to raster layers in the persistent database 
+    * Access to raster time-series in the persistent database 
+* Time-series sampling 
+    * Sampling of a STRDS with vector points 
+* Landsat NDVI computation 
+* Sentinel-2 NDVI computation 
+* User defined processing  
+    * The actinia process chain 
+    * Sentinel-2A NDVI process chain 
+* License 
+* Authors
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -26,3 +26,14 @@ docs_dir:  docs
 theme:     readthedocs
 # https://github.com/mkdocs/mkdocs/issues/991
 use_directory_urls: true
+nav:
+  - Home: 'index.md'
+  - Introduction: 'introduction.md'
+  - Installation: 'installation.md'
+  - Actinia database access: 'tutorial_data_access.md'
+  - Time-series sampling: 'tutorial_strds_sampling.md'
+  - Landsat NDVI computation: 'tutorial_landsat_ndvi.md'
+  - Sentinel-2A NDVI computation: 'tutorial_sentinel2_ndvi.md'
+  - User defined processing: 'tutorial_process_chain.md'
+  - License: 'license.md'
+  - Authors: 'authors.md'