Update user manual (#295)

* Update about page user manual * Added guide for the map page * Minor change minor change Co-authored-by: Jeremy-Prior <[email protected]> --------- Co-authored-by: Jeremy-Prior <[email protected]>
kartoza · Jan 25, 2024 · 25159d1 · 25159d1
1 parent 46cacdf
commit 25159d1
Show file tree

Hide file tree

Showing 14 changed files with 90 additions and 3 deletions.
diff --git a/docs/src/user/guide/img/map-1.png b/docs/src/user/guide/img/map-1.png
diff --git a/docs/src/user/guide/img/map-2.png b/docs/src/user/guide/img/map-2.png
diff --git a/docs/src/user/guide/img/map-3.png b/docs/src/user/guide/img/map-3.png
diff --git a/docs/src/user/guide/img/map-4.png b/docs/src/user/guide/img/map-4.png
diff --git a/docs/src/user/guide/img/map-5.png b/docs/src/user/guide/img/map-5.png
diff --git a/docs/src/user/guide/img/map-6.png b/docs/src/user/guide/img/map-6.png
diff --git a/docs/src/user/guide/img/map-7.png b/docs/src/user/guide/img/map-7.png
diff --git a/docs/src/user/guide/index.md b/docs/src/user/guide/index.md
@@ -11,5 +11,6 @@ The guide section of the documentation provides short narrative/workflow based t
 * **[Search Metadata:](./search-metadata.md)** This page will show you how to search for metadata on the platform.
 * **[Upload Metadata:](./create-metadata.md)** This page will show you how to upload metadata to the platform.
 * **[Edit Metadata:](./edit-metadata.md)** This page will show you how to edit metadata on the platform.
+* **[Map:](./map.md)** This page will show you how visualise metadata on the map.
 
 
diff --git a/docs/src/user/guide/map.md b/docs/src/user/guide/map.md
@@ -0,0 +1,56 @@
+# Map User Guide
+
+## Overview
+
+The `Map` interface on the SAEOSS-Portal provides users with a visual representation of Earth Observation datasets through polygon footprints, showcasing the boundaries covered by respective metadata records. This guide will help you navigate and utilise the various features available on the Map tab.
+
+![map](./img/map-1.png)
+
+## Explore Metadata Records
+
+Click on the Right Arrow to open a side panel with a list of available metadata records and search filters.
+
+1. **Search Filters:** Use the search filters to explore metadata records based on content, time, and location.
+
+    - Search by Keyword
+    - Search by Date
+
+    ![search metadata](./img/map-2.png)
+
+## Visualise Geographical Areas
+
+![metadata](./img/map-3.png)
+
+- Click on a metadata record to visualise its corresponding geographic area on the map.
+
+- The highlighted area provides a visual reference, and detailed information can be obtained by clicking within it.
+
+## Zoom In and Out
+
+Utilise the `Zoom` functionality to get a closer or broader view of the map.
+
+## Choose Base Map
+
+Select from various Base Map Options to customise your viewing experience.
+
+**Base Map Options**
+
+1. **OpenStreetMap Street View:** Traditional street map displaying road networks and landmarks.
+
+    ![OpenStreetMap Street View](./img/map-4.png)
+
+2. **OpenStreetMap Hybrid View:** Combined satellite imagery with street map information.
+
+    ![OpenStreetMap Hybrid View](./img/map-5.png)
+
+3. **OpenStreetMap Pioneer View:** Designed for outdoor activities, highlighting topographic details.
+
+    ![OpenStreetMap Pioneer View](./img/map-6.png)
+
+4. **OpenStreetMap Neighbourhood View:** Emphasises localised mapping for neighbourhood-level details.
+
+    ![OpenStreetMap Neighbourhood View](./img/map-7.png)
+
+## Conclusion
+
+The Map interface empowers users to interact with spatial Earth Observation datasets effectively. Navigate through metadata records, visualise geographic areas, and customise your map view for a comprehensive and enriching experience. Feel free to explore and contribute to the data-rich world of the SAEOSS-Portal!
diff --git a/docs/src/user/manual/about.md b/docs/src/user/manual/about.md
@@ -1,7 +1,37 @@
 # About
 
-User can navigate to the page by select `About` on the tab. Users will be able to read on the vision of the portal and the reason to contribute.
+The `About` page on the SAEOSS-Portal provides users with insightful information about the platform's vision and compelling reasons to contribute.
 
-![about](img/about-page-1.png)
+![about page](img/about-page-1.png)
 
-![vision](img/about-page-2.png)
+1. **About:** The users can navigate to the page by selecting `About` on the tab. Users will be able to read the vision of the portal and the reason to contribute.
+
+## About SAEOSS-Portal
+
+Welcome to the `SAEOSS-Portal`, a cutting-edge collaboration between SANSA (South African National Space Agency) and SAEON (South African Earth Observation Network). This platform is the result of a visionary partnership aimed at transforming the landscape of data sharing. The `SAEOSS-Portal` is dedicated to promoting synergy and knowledge exchange among diverse entities, contributing to a more interconnected world.
+
+![about saeoss-portal](img/about-page-2.png)
+
+## Our Vision
+
+At the `SAEOSS-Portal`, we envision a future where data knows no boundaries. Our vision is rooted in the belief that the true power of data lies not only in its creation but also in its responsible sharing and utilisation. This platform serves as a bridge, connecting organisations, governments, and individuals, propelling them toward data-driven excellence.
+
+![vision](img/about-page-3.png)
+
+## Join the Data Revolution
+
+1. **Inviting Participation:** We extend an invitation to organisations, institutions, and individuals to join the data revolution. Whether you represent a research institution, a government agency, or advocate for data-driven solutions, the SAEOSS-Portal offers a unique opportunity to contribute to a more interconnected and data-rich world.
+
+2. **Create an Account:** To become a part of this transformative journey, create an account on the `SAEOSS-Portal`. By doing so, you not only become a catalyst for change in the data ecosystem but also gain access to a wealth of knowledge and insights.
+
+![revolution](img/about-page-4.png)
+
+3. **Benefits of Joining:**
+
+    - **Access to Rich Data:** Explore and access a diverse range of data sets contributed by various entities.
+
+    - **Collaboration Opportunities:** Connect with like-minded organisations and individuals for collaborative projects and initiatives.
+
+    - **Data-Driven Excellence:** Harness the power of data to drive transformative decision-making across various sectors.
+
+    - **Contribution to a Global Network:** Be a part of a community dedicated to responsible data sharing and utilisation.
diff --git a/docs/src/user/manual/img/about-page-1.png b/docs/src/user/manual/img/about-page-1.png
diff --git a/docs/src/user/manual/img/about-page-2.png b/docs/src/user/manual/img/about-page-2.png
diff --git a/docs/src/user/manual/img/about-page-3.png b/docs/src/user/manual/img/about-page-3.png
diff --git a/docs/src/user/manual/img/about-page-4.png b/docs/src/user/manual/img/about-page-4.png