Add Gea Reforestation user guide (#81)

config.json

@@ -1,22 +1,28 @@
 {
   "general": {
-    "name" : "QGIS GEA afforestation tool",
-    "qgisMinimumVersion": 3.20,
+    "name": "QGIS GEA afforestation tool",
+    "qgisMinimumVersion": 3.2,
     "qgisMaximumVersion": 3.99,
     "icon": "icon.png",
     "experimental": false,
     "deprecated": false,
     "homepage": "https://github.com/kartoza/qgis-gea-plugin",
     "tracker": "https://github.com/kartoza/qgis-gea-plugin/issues",
     "repository": "https://github.com/kartoza/qgis-gea-plugin",
-    "tags": ["gea", "maps", "afforestation"],
-    "category": ["plugins"],
+    "tags": [
+      "gea",
+      "maps",
+      "afforestation"
+    ],
+    "category": [
+      "plugins"
+    ],
     "hasProcessingProvider": "no",
     "about": "Adds functionality inside QGIS to enable GEA afforestation visualization and analysis.",
     "author": "Kartoza",
     "email": "info@kartoza.com",
     "description": "View, browse and navigate through imagery.",
-    "version": "0.0.1",
+    "version": "1.0.0",
     "changelog": ""
   }
-}
+}

docs/src/user/guide/gea-reforestation.md

@@ -0,0 +1,167 @@
+# The GEA Reforestation QGIS Project User Guide
+
+## Introduction
+
+Welcome to the user guide tutorial for the GEA Reforestation project using QGIS. This guide will walk you through the steps to get started with the project and how to use the various tools and features available.
+
+The GEA Reforestation project is a collaborative effort between the Head Office and Field Office to track and manage reforestation activities. This project leverages the power of QGIS, a free and open-source geographic information system (GIS) software, to provide a comprehensive solution for the reforestation process.
+
+## Getting Started:
+
+**Accessing the Project Folder:** The project folder is shared by the Head Office and can be downloaded by the Field Office/You.
+
+The folder should contain the following components:
+
+- Masks
+- Images
+- Package for vector data
+- QGIS project file (project.qgz)
+
+**Extracting the Project Folder**:
+
+- Download the project folder sharesd by the head office.
+
+![Shared folder](./img/gea-reforestation-1.png)
+
+- Extract the folder to access the necessary files and folders.
+
+![Extracted folder](./img/gea-reforestation-2.png)
+![File/Folders](./img/gea-reforestation-3.png)
+
+## Opening the QGIS Project:
+
+**Launching QGIS:** If you don't have QGIS installed on your system, refer to the [Quickstart Guide](../quickstart/index.md) for detailed instructions on how to install the QGIS.
+
+**Opening the Project File:** Right-click on the 1️⃣ `project.qgz` file and select 2️⃣ `Open with QGIS`. This will launch the QGIS application and open the GEA Reforestation project.
+
+## Exploring the QGIS Interface:
+
+![QGIS interface](./img/gea-reforestation-7.png)
+
+1. **Attributs Toolbar:**
+
+- **Pan**: Click on the 1️⃣ `Pan` icon, to pan the map canvas.
+
+- **Zoom In**: Click on the 2️⃣ `Zoom IN` icon, and drag to select the area you want to zoom in on on the map canvas.
+
+- **Zoom Out**: Click on the 3️⃣ `Zoom Out` icon, and drag to select the area you want to zoom out on the map canvas.
+
+- **Full Zoom**: Click on the 4️⃣ `Full Zoom` icon, to zoom to the full extent of the map.
+
+- **Show Map Tips**: Click on the 5️⃣ `Show Map Tips` icon, to display additional information about the map, such as coordinates and scale.
+
+![Attributes toolbar](./img/gea-reforestation-5.png)
+
+2. **Vector Toolbar:** 
+
+- **Current edits:** 1️⃣ `Current edits` displays the current editing state of the layer.
+
+- **Toggle editing:** Click on the 2️⃣ to toggles the editing mode on or off.
+
+- **Save layer edits:** Click on the 3️⃣ to save any changes made to the layer.
+
+- **Add polygon feature:** Click on the 4️⃣ to creates a new polygon feature on the map.
+
+![Vector toolbar](./img/gea-reforestation-6.png)
+
+3. **Layer List:**
+
+![layer list](./img/gea-reforestation-8.png)
+
+You can utilise the `Layers List` panel to visualise and interact with the various layers in the project. In the Layers panel, you will see the following layers listed:
+
+- Malawi 2 Area of Interest
+- Malawi 2 Buffer
+- Proposed Site Boundaries
+- Administrative Areas (Malawi 2 Country, Malawi 2 District, Malawi 2 Sub-divisional Administrative Unit)
+- Exclusion Masks (Grass, Wetland, Forest, Soil Carbon)
+- Current Google Imagery
+- Recent NICFI Imagery
+- Historical Landsat Imagery
+
+**Exploring the Layers:**
+
+![Malavi 2](./img/gea-reforestation-9.png)
+
+**Malawi 2 Area of Interest:**
+
+- Check the `Malawi 2 Area of Interest` checkbox to visualise the area of interest on the map canvas. You will see a black line outlining the area.
+
+**Malawi 2 Buffer:**
+
+- Check the `Malawi 2 Buffer` checkbox to visualise the buffer area around the Malawi 2 area of interest. You will see a yellow line on the map canvas.
+
+**Proposed Site Boundaries:**
+
+- Check the `Proposed Site Boundaries` checkbox to display the proposed boundaries created by the user for the project. You will see red lines on the map canvas representing the proposed boundaries.
+
+**Administrative Areas:**
+
+![Areas](./img/gea-reforestation-10.png)
+
+- Malawi 2 Country: Check the `Malawi 2 Country` checkbox to visualise the country boundaries of Malawi. You will see a green line on the map canvas.
+
+- Malawi 2 District: Check the `Malawi 2 District` checkbox to visualise the district boundaries within Malawi. You will see white lines on the map canvas.
+
+- Malawi 2 Sub-divisional Administrative Unit: Check the `Malawi 2 Sub-divisional Administrative Unit` checkbox to visualise the sub-divisional administrative unit boundaries within Malawi. You will see blue lines on the map canvas.
+
+**Exclusion Masks:**
+
+![Masks](./img/gea-reforestation-11.png)
+
+- Malawi 2 Grass Exclusion Mask
+- Malawi 2 Wetland Exclusion Mask
+- Malawi 2 Forest Exclusion Mask
+- Malawi 2 Soil Carbon Exclusion Mask
+
+Check the respective checkboxes to visualise the exclusion masks on the map canvas. These masks represent areas where the project cannot be implemented.
+
+**Imagery Layers:**
+
+- **Current Google Imagery:** Check the checkbox to view the most recent `Google imagery`.
+
+- **Recent NICFI Imagery:** To view the `NICFI` imagery, you need to turn off the Google Imagery and Historical Landsat Imagery layers first and select the recent nicfi imagery.
+
+![Nicfi](./img/gea-reforestation-12.png)
+
+    >NOTE: To view the NICFI imagery you need to register/login to the planet explore site. If you are not already register on the site you can refer the below links for the detailed documentation on register/login.
+
+- [Register to the Planet Explore site](./sign-up.md)
+
+- [Login to the Planet Explore site](./login.md)
+
+- **Historical Landsat Imagery:** Check the checkbox to view the historical Landsat imagery. You need to turn off the Google Imagery and NICFI Imagery layers to see the `Historical Landsat imagery`.
+
+![Historical Landsat](./img/gea-reforestation-13.png)
+
+By selectively toggling the visibility of the different layers, you can customise the map view and gain valuable insights for the GEA Reforestation Project.
+
+With the GEA Reforestation QGIS project opened and the basic navigation tools explored, you are now ready to dive deeper into the project and start working on the reforestation activities. 
+
+## How to style image for better visualisation?
+
+This user guide will show you how to change the image styles in QGIS symbology to enhance the quality and realism of your images.
+
+**Step 1: Open QGIS and Load Your Project**
+
+To get started, open QGIS and load your existing project, or simply open your QGIS project (e.g. Malawi 2) with QGIS.
+
+**Step 2: Open the Layer Properties**
+
+In the Layers panel, right-click on the layer for which you want to change the symbology and select the 1️⃣ `Properties`. This will open the Layer Properties dialog box.
+
+![Properties](./img/image-style-1.png)
+
+**Step 3: Open the Symbology Tab**
+
+In the Layer Properties dialog box, click on the 1️⃣ `Symbology` tab on the left side. This will open the Symbology settings. In the Symbology settings, locate the settings for contrast enhancement. In the contrast enhancement dropdown, select the 2️⃣ `Stretch to MinMax` option. This will adjust the contrast of the image to make it more visually appealing.
+
+![Contrast](./img/image-style-2.png)
+
+**Step 4: Configure Min/Max Value Settings**
+
+Click on the 1️⃣ `Min/Max value setting` to view more options. Choose the 2️⃣ `Mean +/- standard deviation` option. This will adjust the minimum and maximum values of the image to make it more realistic. Click on the 3️⃣ `Apply` to apply the changes and continue making adjustments. Alternatively, click on the 4️⃣ `OK` to apply the changes and close the Layer Properties window.
+
+![Contrast](./img/image-style-3.png)
+
+By following these steps, you can change the image styles in QGIS symbology to enhance the quality and realism of your images. Remember to experiment with different settings to get the most realistic-looking or fit-for-purpose image.