Structure clean (#89)

* Clean the guide structure * Change the title * Rename the file name * Clean the user manual structure * Update yml and index file * Rename file * Minor change
kartoza · Sep 2, 2024 · 14d64a1 · 14d64a1
1 parent 2a0c03c
commit 14d64a1
Show file tree

Hide file tree

Showing 35 changed files with 51 additions and 49 deletions.
diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml
@@ -49,17 +49,19 @@ nav:
                   - Quickstart: user/quickstart/index.md
                   - Guide:
                           - user/guide/index.md
+                          - GEA Reforestation: user/guide/gea-reforestation.md
+                          - GEA Reforestation Tool (Plugin): user/guide/gea-reforestation-tool.md
+                          - NICFI Imagery: user/guide/nicfi-imagery.md
                           - Sign Up: user/guide/sign-up.md
                           - Login: user/guide/login.md
-                          - Reports: user/guide/reports.md
                   - Manual :
                           - user/manual/index.md
-                          - Sign Up: user/manual/sign-up.md
-                          - Login: user/manual/login.md
                           - GEA Reforestation: user/manual/gea-reforestation.md
-                          - GEA Reforestation Tool: user/manual/gea-reforestation-tool.md
+                          - GEA Reforestation Tool (Plugin): user/manual/gea-reforestation-tool.md
+                          - NICFI Imagery: user/manual/nicfi-imagery.md
                           - Image Style: user/manual/image-style.md
-                          - Reports: user/manual/reports.md
+                          - Sign Up: user/manual/sign-up.md
+                          - Login: user/manual/login.md
                   - user/user-workflow.md
                   - user/Appendix1.md
 

diff --git a/docs/src/about/code-of-conduct.md b/docs/src/about/code-of-conduct.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/about/contributing.md b/docs/src/about/contributing.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/about/index.md b/docs/src/about/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/about/running-instances.md b/docs/src/about/running-instances.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/administrator/index.md b/docs/src/administrator/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/administrator/manual/index.md b/docs/src/administrator/manual/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/api/guide/index.md b/docs/src/developer/api/guide/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/api/index.md b/docs/src/developer/api/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/api/manual/index.md b/docs/src/developer/api/manual/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/architecture.md b/docs/src/developer/guide/architecture.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/building.md b/docs/src/developer/guide/building.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/cloning.md b/docs/src/developer/guide/cloning.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/configuration.md b/docs/src/developer/guide/configuration.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/design.md b/docs/src/developer/guide/design.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/ide-setup.md b/docs/src/developer/guide/ide-setup.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/index.md b/docs/src/developer/guide/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/prerequisites.md b/docs/src/developer/guide/prerequisites.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/roadmap.md b/docs/src/developer/guide/roadmap.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/templates/commit-message-convention.md b/docs/src/developer/guide/templates/commit-message-convention.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/templates/pull-request-template.md b/docs/src/developer/guide/templates/pull-request-template.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/guide/workflows.md b/docs/src/developer/guide/workflows.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/developer/index.md b/docs/src/developer/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/devops/guide/index.md b/docs/src/devops/guide/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/devops/index.md b/docs/src/devops/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/devops/manual/index.md b/docs/src/devops/manual/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024
@@ -9,7 +9,7 @@ contact: PROJECT_CONTACT
 license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
 ---
 
-# GEA AFFORESTATION
+# GEA Reforestation
 
 ![Gea reforestation](./img/gea-home-1.png)
 

diff --git a/docs/src/user/guide/index.md b/docs/src/user/guide/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024
@@ -9,12 +9,14 @@ contact: PROJECT_CONTACT
 license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
 ---
 
-# User guide
-<!-- Narrative Instructions on how to use the product/platform -->
-<!-- Replace all of the titles with relevant titles -->
+# GEA Reforestation user guide
+
+* **[GEA Reforestation:](gea-reforestation.md)** A comprehensive guide to the GEA Reforestation QGIS Project. It covers project setup, QGIS interface navigation, and detailed explanations of project layers including administrative boundaries, exclusion masks, and various imagery sources (Google, NICFI, Landsat). The guide also includes instructions for image enhancement techniques.
+
+* **[GEA Reforestation Tool (Plugin):](gea-reforestation-tool.md)** This guide details the installation and use of the GEA Reforestation Tool Plugin for QGIS. It covers plugin installation, using the time slider for historical imagery, the Drawing Tool for creating project areas, and generating automated reports. Step-by-step instructions with screenshots are provided throughout.
+
+* **[NICFI Imagery:](nicfi-imagery.md)** A tutorial on accessing and using NICFI imagery in QGIS. It covers Planet Explore account setup, enabling NICFI layers in QGIS, selecting specific imagery dates, and using QGIS tools for analysis. The guide also provides tips for effective use of NICFI imagery in tropical forest analysis and conservation projects.
 
 * **[Sign Up:](sign-up.md)** This page will show you how to `sign up` for Planet Explorer.
 
 * **[Login:](login.md)** This page will show you how to `log in` to Planet Explorer.
-
-* **[Reports:](reports.md)** This page will show how you can generate the reports.
diff --git a/docs/src/user/guide/reports.md b/docs/src/user/guide/reports.md
diff --git a/docs/src/user/index.md b/docs/src/user/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024

diff --git a/docs/src/user/manual/gea-reforestation.md.md → docs/src/user/manual/gea-reforestation.md b/docs/src/user/manual/gea-reforestation.md.md → docs/src/user/manual/gea-reforestation.md
diff --git a/docs/src/user/manual/Image-style.md → docs/src/user/manual/image-style.md b/docs/src/user/manual/Image-style.md → docs/src/user/manual/image-style.md
diff --git a/docs/src/user/manual/index.md b/docs/src/user/manual/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024
@@ -16,14 +16,14 @@ what the various components of that page do. The manual is intended to function
 as a reference for the application. For narrative / workflow based tutorials,
 you may prefer to work through our [user guide](../guide/index.md).
 
-* **[Sign Up:](sign-up.md)** This page will show how the user can `sign up` for Planet Explorer.
+* **[GEA Reforestation:](gea-reforestation.md)** This documentation provides detailed instructions on what to do with the shared project and how to open it with QGIS also explains the steps to prepare and open a QGIS project for using the GEA Reforestation Tool, navigate the QGIS interface, and customise the visualisation of different layers to gain valuable insights for a reforestation project.
 
-* **[Login:](login.md)** This page will show how the user can `log in` to Planet Explorer.
+* **[GEA Reforestation Tool:](gea-reforestation-tool.md)** This manual explains the usage of the GEA Reforestation Tool, a plugin for QGIS, which allows users to visualise historical imagery, access different landscape maps, and generate reports for potential reforestation sites. The manual covers the Time Slider feature, which enables users to view selected imagery on the map canvas, and the Drawing Tool, which allows users to draw polygons on the map canvas to identify potential reforestation sites. Additionally, the manual explains the automated report generation feature, which provides users with a detailed report on the project area.
 
-* **[GEA Reforestation:](gea-reforestation.md)** This documentation provides detailed instructions on what to do with the shared project and how to open it with QGIS also explains some useful options that users can use in the QGIS.
+* **[NICFI Imagery:](nicfi-imagery.md)** This documentation provides an overview of the NICFI Imagery, a collection of high-resolution, analysis-ready mosaics of the world's tropics, provided by Planet. The documentation explains why NICFI Imagery is not included in the project file, how to access it, and how to use it in QGIS. It also provides an overview of the benefits of using NICFI Imagery, including high-resolution imagery, support for non-commercial uses, and access to a large collection of imagery data without the need for a massive file size.
 
-* **[GEA Reforestation Tool:](gea-reforestation-tool)** This documentation will explain how to user the plugin.
+* **[Image Style:](image-style.md)** This page will show how the user can style the image for the better experience.
 
-* **[Image Style:](Image-style.md)** This page will show how the user can style the image for the better experience.
+* **[Sign Up:](sign-up.md)** This page will show how the user can `sign up` for Planet Explorer.
 
-* **[Reports:](reports.md)** This page will show how the user can generate the reports.
+* **[Login:](login.md)** This page will show how the user can `log in` to Planet Explorer.
diff --git a/docs/src/user/manual/reports.md b/docs/src/user/manual/reports.md
diff --git a/docs/src/user/quickstart/index.md b/docs/src/user/quickstart/index.md
@@ -1,5 +1,5 @@
 ---
-title: GEA AFFORESTATION
+title: GEA Reforestation
 summary: PROJECT_SUMMARY
     - Ketan Bamniya
 date: 19-06-2024