Add indicators page docs (#13)

unicef-drp · Feb 7, 2025 · 29d8cfd · 29d8cfd
1 parent ad03be1
commit 29d8cfd
Show file tree

Hide file tree

Showing 29 changed files with 200 additions and 2 deletions.
diff --git a/mkdocs-base.yml b/mkdocs-base.yml
@@ -47,8 +47,7 @@ nav:
                 - Running Instances: about/running-instances.md
         - Users:
                 - user/index.md
-                - Quick Start: 
-                        - user/quickstart/index.md
+                - Quick Start: user/quickstart/index.md
                 - Guide:
                         - user/guide/index.md
                         - Creating Your Account: user/guide/creating-your-account.md
@@ -70,6 +69,9 @@ nav:
                         - "": user/guide/API_Documentation.md
                 - Manual: 
                         - user/manual/index.md
+                        - Project Page:
+                                       - Visualisation Section: user/manual/visualisation/index.md
+                                       - Indicators Page: user/manual/visualisation/indicators-page.md
                         - Home Page: user/manual/home.md
                         - Dashboard Page: user/manual/dashboard.md
                         - Analysis Tools: user/manual/analysis-tools.md

diff --git a/src/user/manual/visualisation/img/indicators-img-1.png b/src/user/manual/visualisation/img/indicators-img-1.png
diff --git a/src/user/manual/visualisation/img/indicators-img-10.png b/src/user/manual/visualisation/img/indicators-img-10.png
diff --git a/src/user/manual/visualisation/img/indicators-img-11.png b/src/user/manual/visualisation/img/indicators-img-11.png
diff --git a/src/user/manual/visualisation/img/indicators-img-12.png b/src/user/manual/visualisation/img/indicators-img-12.png
diff --git a/src/user/manual/visualisation/img/indicators-img-13.png b/src/user/manual/visualisation/img/indicators-img-13.png
diff --git a/src/user/manual/visualisation/img/indicators-img-14.png b/src/user/manual/visualisation/img/indicators-img-14.png
diff --git a/src/user/manual/visualisation/img/indicators-img-15.png b/src/user/manual/visualisation/img/indicators-img-15.png
diff --git a/src/user/manual/visualisation/img/indicators-img-16.png b/src/user/manual/visualisation/img/indicators-img-16.png
diff --git a/src/user/manual/visualisation/img/indicators-img-17.png b/src/user/manual/visualisation/img/indicators-img-17.png
diff --git a/src/user/manual/visualisation/img/indicators-img-18.png b/src/user/manual/visualisation/img/indicators-img-18.png
diff --git a/src/user/manual/visualisation/img/indicators-img-19.png b/src/user/manual/visualisation/img/indicators-img-19.png
diff --git a/src/user/manual/visualisation/img/indicators-img-2.png b/src/user/manual/visualisation/img/indicators-img-2.png
diff --git a/src/user/manual/visualisation/img/indicators-img-20.png b/src/user/manual/visualisation/img/indicators-img-20.png
diff --git a/src/user/manual/visualisation/img/indicators-img-21.png b/src/user/manual/visualisation/img/indicators-img-21.png
diff --git a/src/user/manual/visualisation/img/indicators-img-22.png b/src/user/manual/visualisation/img/indicators-img-22.png
diff --git a/src/user/manual/visualisation/img/indicators-img-23.png b/src/user/manual/visualisation/img/indicators-img-23.png
diff --git a/src/user/manual/visualisation/img/indicators-img-24.png b/src/user/manual/visualisation/img/indicators-img-24.png
diff --git a/src/user/manual/visualisation/img/indicators-img-25.png b/src/user/manual/visualisation/img/indicators-img-25.png
diff --git a/src/user/manual/visualisation/img/indicators-img-26.png b/src/user/manual/visualisation/img/indicators-img-26.png
diff --git a/src/user/manual/visualisation/img/indicators-img-3.png b/src/user/manual/visualisation/img/indicators-img-3.png
diff --git a/src/user/manual/visualisation/img/indicators-img-4.png b/src/user/manual/visualisation/img/indicators-img-4.png
diff --git a/src/user/manual/visualisation/img/indicators-img-5.png b/src/user/manual/visualisation/img/indicators-img-5.png
diff --git a/src/user/manual/visualisation/img/indicators-img-6.png b/src/user/manual/visualisation/img/indicators-img-6.png
diff --git a/src/user/manual/visualisation/img/indicators-img-7.png b/src/user/manual/visualisation/img/indicators-img-7.png
diff --git a/src/user/manual/visualisation/img/indicators-img-8.png b/src/user/manual/visualisation/img/indicators-img-8.png
diff --git a/src/user/manual/visualisation/img/indicators-img-9.png b/src/user/manual/visualisation/img/indicators-img-9.png
diff --git a/src/user/manual/visualisation/index.md b/src/user/manual/visualisation/index.md
@@ -0,0 +1,17 @@
+---
+title: GeoSight-OS Data Importer Page 
+summary: GeoSight is UNICEF's geospatial web-based business intelligence platform.
+    - Tim Sutton
+    - Irwan Fathurrahman
+    - Ketan Bamniya
+date: 2024-09-01
+some_url: https://github.com/unicef-drp/GeoSight-OS
+copyright: Copyright 2024, Unicef
+contact: [email protected]
+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.
+#context_id: 1234
+---
+
+# Visualisation 
+
+* **[Indicators](./indicators-page.md):** Allows users to walk through the Indicator tab.
diff --git a/src/user/manual/visualisation/indicators-page.md b/src/user/manual/visualisation/indicators-page.md
@@ -0,0 +1,179 @@
+---
+title: GeoSight-OS Data Importer Page 
+summary: GeoSight is UNICEF's geospatial web-based business intelligence platform.
+    - Tim Sutton
+    - Irwan Fathurrahman
+    - Ketan Bamniya
+date: 2024-09-01
+some_url: https://github.com/unicef-drp/GeoSight-OS
+copyright: Copyright 2024, Unicef
+contact: [email protected]
+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.
+#context_id: 1234
+---
+
+# Indicators
+
+[![Indicator Home Page](./img/indicators-img-1.png)](./img/indicators-img-1.png)
+
+1. **Indicators:** Users are required to click on this tab to view the list of indicators available.
+
+[![Indicator Home Page 2](./img/indicators-img-2.png)](./img/indicators-img-2.png)
+
+1. **Search Indicator:** Users can search for specific indicators using the search bar.
+
+2. **Create New Indicator:** Users can create a new indicator by clicking on the `Create New Indicator` button.
+
+3. **Edit:** Allows users to edit the selected indicator.
+
+4. **Delete:** Allows users to delete the selected indicator.
+
+5. **Filter:** Allows users to filter the data based on specific criteria.
+
+6. **Data Table:** Displays the list of available indicators.
+
+7. **Additional Operations:** Allows users to perform additional operations on the indicator.
+
+8. **Pagination:** Displays the current number of records along with the total number of records. 
+
+## Create New Indicator
+
+### General
+
+[![Create New Indicator](./img/indicators-img-3.png)](./img/indicators-img-3.png)
+
+1. **General:** Allows users to access the general tab.
+
+2. **Form:** This form contains the general information about the indicator.
+
+    * **Name:** The name of the indicator. After entering the name of the indicator similar indicators are also displayed.
+
+        [![Similar Indicators](./img/indicators-img-4.png)](./img/indicators-img-4.png)
+
+    * **Description:** The description of the indicator.
+
+    * **Source:** The source of the indicator.
+
+    * **Shortcode:** The shortcode for the indicator.
+
+    * **Category:** Users are required to select the category for the respective indicator from the dropdown menu.
+
+    * **Unit:** Respective unit for the indicator.
+
+    * **Indicator type:** Users are required to select the type of indicator from the dropdown menu.
+
+    * **Min value:** Minimum value of the indicator.
+
+    * **Max value:** Maximum value of the indicator.
+
+3. **Save:** Saves the indicator. After saving the indicator users will be notified by the alert notification and the indicator will be displayed in the data table.
+
+    ![Saved](./img/indicators-img-5.png)
+
+### Aggregation
+
+[![Aggregation](./img/indicators-img-6.png)](./img/indicators-img-6.png)
+
+1. **Aggregation:** Allows users to access the aggregation tab.
+
+2. **Allow aggregation upper level:** Users are required to check whether the aggregation is allowed at the upper level or not.
+
+3. **Aggregation upper level/values:** Users can select the aggregation upper level and values.
+
+4. **Save As:** Saves the aggregation as a new indicator.
+
+5. **Save:** Saves the aggregation. After saving the aggregation users will be notified by the alert notification and
+
+### Style
+
+[![Style](./img/indicators-img-7.png)](./img/indicators-img-7.png)
+
+1. **Style:** Allows users to access the style tab.
+
+2. **Save:** Saves the style. After saving the style users will be notified by the alert notification.
+
+3. **Style type:** Users are required to select the style type from the dropdown menu.
+
+4. **Palette:** Users are required to select the colour palette from the dropdown menu.
+
+    ![Colour Palette](./img/indicators-img-8.png)
+
+5. **Reverse:** Reverse the colour palette.
+
+6. **Classification:** Users can select the classification from the dropdown menu.
+
+    ![Classification](./img/indicators-img-9.png)
+
+7. **Number of Classes:** Users can enter the number classes they want in this input field.
+
+8. **Sync fill and Outline Color:** Users can fill the outline colour and width here.
+
+9. **Apply when filtering:** Users can apply style on filter as well by checking this.
+
+### Label 
+
+[![Label](./img/indicators-img-10.png)](./img/indicators-img-10.png)
+
+1. **Label:** Allows users to access the label tab.
+
+2.  **Style Label:** Users can style the label according to their preference using this tab and view the preview as well.
+
+3. **Text:** Users can modify the label text here.
+
+### Share
+
+User can use this tab to share the indicators with other users. Click [here](../share.md) to see how to share.
+
+## Edit Indicators
+
+[![Edit Indicator](./img/indicators-img-11.png)](./img/indicators-img-11.png)
+
+1. **Edit:** Users are required to check the checkbox of the respective indicator, only then users will be able to edit the indicator.
+
+[![Edit Indicator UI](./img/indicators-img-12.png)](./img/indicators-img-12.png)
+
+* All the fields are same as the create indicator tab except they are all disabled. Users can enable them by checking the checkbox of the respective field.
+
+    [![Edit Indicator UI 2](./img/indicators-img-13.png)](./img/indicators-img-13.png)
+
+    [![Edit Indicator UI 3](./img/indicators-img-14.png)](./img/indicators-img-14.png)
+
+## Delete Indicators
+
+[![Delete Indicator](./img/indicators-img-15.png)](./img/indicators-img-15.png)
+
+1. **Delete Indicator:** Users are required to check the checkbox of the respective indicator, only then users will be able to delete the indicator. Users will receive a pop-up dialog box to confirm the deletion. Users can also delete multiple indicators at once.
+
+    ![Delete Confirmation](./img/indicators-img-16.png)
+
+    * **Cancel:** Users can cancel the deletion by clicking on this button.
+
+    * **Confirm:** Users can confirm the deletion by clicking on this button.
+
+    * **X:** Users can close the pop-up dialog box by clicking on this button.
+
+## Filter the data
+
+![Filter Data](./img/indicators-img-17.png)
+
+1. **![Filter Icon](./img/indicators-img-18.png):** Users can filter the data by clicking on this icon.
+
+    ![Filter List](./img/indicators-img-19.png)
+
+    * **Apply Filters:** First users are required to fill the field on the basis of which they want to filter the data. After selecting the filter, users can apply it by clicking on this button.
+
+## Additional Operations
+
+![Additional Operations](./img/indicators-img-20.png)
+
+1. **![Browse Data Icon](./img/indicators-img-21.png):** Users can browse the data by clicking on this icon.
+
+2. **![Import Data Icon](./img/indicators-img-22.png):** Users can import the data by clicking on this icon.
+
+3. **![Management Form Icon](./img/indicators-img-23.png):** Users can manage the form by clicking on this icon.
+
+4. **![Management Map Icon](./img/indicators-img-24.png):** Users can manage the map by clicking on this icon.
+
+5. **![Go To Data Access](./img/indicators-img-25.png):** Users can go to the data access page by clicking on this icon.
+
+6. **![Share Icon](./img/indicators-img-26.png):** Users can share the data by clicking on this icon. Click [here](../share.md) to know more about sharing.