Merge remote-tracking branch 'upstream/main'

Jeremy-Prior · Dec 5, 2024 · fcf80f0 · fcf80f0
2 parents 1235dfe + a81cd64
commit fcf80f0
Show file tree

Hide file tree

Showing 40 changed files with 432 additions and 0 deletions.
diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml
@@ -75,6 +75,13 @@ nav:
                             - Mobile Application Tutorials: user/guide/mobile-app-videos.md
                   - Manual:
                             - user/manual/index.md
+                      - Sign Up: user/manual/sign-up.md
+                      - Login: user/manual/login.md
+                      - Log Out: user/manual/logout.md
+                      - Password Reset: user/manual/password-reset.md
+                      - About: user/manual/about.md
+                      - Contact: user/manual/contact.md
+                      - Help: user/manual/help.md
         - Administrators:
                   - administrator/index.md
                   - Biodiversity Data:

diff --git a/docs/src/user/manual/about.md b/docs/src/user/manual/about.md
@@ -0,0 +1,37 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Tim Sutton
+    - Jeremy Prior
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+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.
+#context_id: 1234
+---
+
+# About
+
+This `About` section provides detailed information about the BIMS project. It offers insights into the project's objectives, purpose, and significance, helping users understand its scope and how it aims to address specific challenges. 
+
+[![Home Page](./img/about-img-1.png)](./img/about-img-1.png)
+
+1. **About:** Click on the `About` tab from the navigation bar to access the about page.
+
+## The Where?
+
+South Africa’s unique freshwater biodiversity is under enormous pressure from human activities, habitat transformation, climate change and invasive species impacts. River health is deteriorating faster than it can be measured, and existing data suggest that human impacts have, and continue to, severely compromise biodiversity and aquatic ecosystem function. This can also have serious adverse consequences for ecosystem services, such as the provision of food and safe, clean drinking water.
+
+## The what?
+
+Managing our freshwater systems and biota requires reliable information on ecosystem change, as well as a backdrop of sound baseline data against which to gauge current trends. Rising to this challenge, the Freshwater Biodiversity Information System (FBIS) is a platform for hosting, visualising and sharing freshwater biodiversity information for South African rivers. Through consultations with data users and contributors, and through collaborations with key partners and stakeholders, the FBIS aims to provide South Africa’s first platform for rapid and reliable assessments of change in freshwater biodiversity and associated ecosystem condition. The project seeks to mobilize and import to the system baseline biodiversity data, identify strategic long-term monitoring sites, and train key organizations on how to use the information system. Through the use of map-based visualisations, user-friendly dashboards and rapid data extraction capabilities, the system will improve knowledge of freshwater biodiversity and long-term river health trends, thereby supporting better-informed river management decisions and conservation planning projects.
+
+## The How?
+
+The system accepts and serves data on species occurrence, abundance and associated habitat parameters, for freshwater algae, invertebrates and fish. In addition to data gleaned from scientific papers, reports and university theses, the FBIS serves (1) invertebrate data from the former ‘Rivers Database’ (national SASS (South African Scoring System) data), (2) invertebrate data from the legacy ‘Biobase Database’ (national aquatic invertebrate data), (3) fish data from the Global Biodiversity Information Facility (GBIF) database, which includes fish data records from the South Africa Institute for Aquatic Biodiversity (SAIAB).Through links with other systems (like the Department of Water and Sanitation’s Water Management System and [SANBI’s Biodiversity GIS platform](https://bgis.sanbi.org/)), the FBIS offers powerful spatial and temporal data filtering functionality designed to cater for the needs of end users ranging from consultants to conservation planners.
+
+## The Who?
+
+The FBIS project is led by the [Freshwater Reserach Centre (FRC)](https://www.frcsa.org.za/) in partnership [Kartoza Open Source Geospatial Solutions](https://kartoza.com/) and the [South African National Biodiversity Institute (SANBI)](https://www.sanbi.org/). The project is funded by the [JRS Biodiversity Foundation](https://jrsbiodiversity.org/) and the South African National Biodiversity Institute (SANBI).
diff --git a/docs/src/user/manual/citation.md b/docs/src/user/manual/citation.md
@@ -0,0 +1,39 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Tim Sutton
+    - Jeremy Prior
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+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.
+#context_id: 1234
+---
+
+# Citation
+
+[![Home Page](./img/citation-img-1.png)](./img/citation-img-1.png)
+
+1. **Citation:** Users can access the citation page by clicking on this tab in the top navigation bar.
+
+## Citation guidelines
+
+Data accessed through the FBIS are free for all—but not free of obligations. Under the terms of the FBIS data users agreement, users who download individual datasets or search results and use them in research or policy agree to cite them using the referencing information provided in the metadata for each data record.
+
+Good citation practices ensure scientific transparency and reproducibility by guiding other researchers to the original sources of information. They also reward data-publishing institutions and individuals by reinforcing the value of sharing open data and demonstrating its impact to their stakeholders and funders.
+
+Users are strongly encouraged to cite data retrieved from the FBIS network according to the recommended citation:
+
+Freshwater Biodiversity Information System (FBIS). 2022. Downloaded from https://freshwaterbiodiversity.org on current date.
+
+> Note: Users also need to cite the individual source references that they have used, which are available in the metadata table provided on the detailed dashboards.
+
+* To cite the scientific article published in the African Journal of Aquatic Science
+
+Helen Dallas, Jeremy Shelton, Tim Sutton, Dimas Tri Cuptura, Mohammed Kajee & Nancy Job (2022) The Freshwater Biodiversity Information System (FBIS) – mobilising data for evaluating long-term change in South African rivers, African Journal of Aquatic Science, 47:3, 291-306, DOI: 10.2989/16085914.2021.1982672
+
+* To cite the User Manual
+
+Freshwater Biodiversity Information System (FBIS). 2022. FBIS User Manual. Prepared by the Freshwater Research Centre and Kartoza.
diff --git a/docs/src/user/manual/contact.md b/docs/src/user/manual/contact.md
@@ -0,0 +1,37 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Tim Sutton
+    - Jeremy Prior
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+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.
+#context_id: 1234
+---
+
+# Contact
+
+[![Home Page](./img/contact-img-1.png)](./img/contact-img-1.png)
+
+1. **Contact:** Users can access the contact page by clicking on this tab.
+
+[![Contact Us Page](./img/contact-img-2.png)](./img/contact-img-2.png)
+
+* **Name:** The name of the user who wishes to establish contact.
+
+* **Email Address:** The valid email address of the user.
+
+* **Subject:** The subject the user wishes to inquire about. Users can either choose a topic from the dropdown list or select the `Other` option and provide a detailed description in the text box.
+
+* **Description:** Detailed description about the subject.
+
+* **I'm not a robot:** Users will be required to verify that they are not a robot by checking the box.
+
+    [![Not A Robot Verification](./img/contact-img-3.png)](./img/contact-img-3.png)
+
+* **Send Feedback:** After filling in all the required details, click this button to submit the `Contact Us` form.
+
+After submitting the form, the `FBIS` team will contact the user to address their concerns.
diff --git a/docs/src/user/manual/help.md b/docs/src/user/manual/help.md
@@ -0,0 +1,81 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Tim Sutton
+    - Jeremy Prior
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+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.
+#context_id: 1234
+---
+
+# Help
+
+[![Home Page](./img/help-img-3.png)](./img/help-img-3.png)
+
+## Getting help using the FBIS platform
+
+We are so pleased that users are using FBIS! The site offers a broad range of features, which are documented in the user [guide](../guide/index.md) and [manual](./index.md). For a quick start, users can explore the walk-through video of the platform. Lastly, although we strive to provide a seamless experience, users may occasionally encounter issues with the site. If such an issue arises, users are encouraged to report it on our issue tracker, and we will do our best to resolve it promptly!
+
+## FBIS Testing site
+
+For practicing the workflows for capturing data on FBIS, users should use the [FBIS Testing site](https://testing.healthyrivers.kartoza.com/). Here, users can add dummy data, as the data are overwritten with a mirror image of the FBIS Live (production) site every week. The same login works for both `FBIS Live` and `FBIS Testing`.
+
+## User Manual
+
+User can also checkout the [user manual](https://freshwaterbiodiversity.org/uploaded/documents/document/MmWwDIn-SCmrqt_lyQVbVw.pdf) for more information about the platform.
+
+## instructional Videos
+
+We have also created a series of instructional videos to help users get started with the platform.
+
+* **Introduction to key FBIS components:**
+
+    ![type:video](https://www.youtube.com/embed/aex5tzLNWAo)
+
+* **Filtering data:**
+
+    ![type:video](https://www.youtube.com/embed/ygVj7yVYyQE)
+
+* **Overview of spatial layers:**
+
+    ![type:video](https://www.youtube.com/embed/_AtjWcbYLWc)
+
+* **Single and multi-site dashboards:**
+
+    ![type:video](https://www.youtube.com/embed/NTGyonmYO9Y)
+
+* **Single and multi-site SASS dashboards:**
+
+    ![type:video](https://www.youtube.com/embed/wPSNDMAyCY4)
+
+* **Taxon dashboard:**
+
+    ![type:video](https://www.youtube.com/embed/mT152Z-Dc4s)
+
+*  **Exporting graphs and CSV files:**
+
+    ![type:video](https://www.youtube.com/embed/xxyER7wa1ts)
+
+* **Adding a site:**
+
+    ![type:video](https://www.youtube.com/embed/RzfL8P7prag)
+
+* **Adding biodiversity data:**
+
+    ![type:video](https://www.youtube.com/embed/1rZByIjWZF0)
+
+* **Adding SASS data:**
+
+    ![type:video](https://www.youtube.com/embed/9JI2D1c-1Jk)
+
+*  **Preparing and adding water temperature time series data:**
+
+    ![type:video](https://www.youtube.com/embed/E0FG2h--4Ew)
+
+* **Preparing an occurrence data upload file:**
+
+    ![type:video](https://www.youtube.com/embed/hWoFoPBdWI4)
diff --git a/docs/src/user/manual/img/about-img-1.png b/docs/src/user/manual/img/about-img-1.png
diff --git a/docs/src/user/manual/img/citation-img-1.png b/docs/src/user/manual/img/citation-img-1.png
diff --git a/docs/src/user/manual/img/contact-img-1.png b/docs/src/user/manual/img/contact-img-1.png
diff --git a/docs/src/user/manual/img/contact-img-2.png b/docs/src/user/manual/img/contact-img-2.png
diff --git a/docs/src/user/manual/img/contact-img-3.png b/docs/src/user/manual/img/contact-img-3.png
diff --git a/docs/src/user/manual/img/help-img-1.png b/docs/src/user/manual/img/help-img-1.png
diff --git a/docs/src/user/manual/img/help-img-2.png b/docs/src/user/manual/img/help-img-2.png
diff --git a/docs/src/user/manual/img/help-img-3.png b/docs/src/user/manual/img/help-img-3.png
diff --git a/docs/src/user/manual/img/login-img-1.png b/docs/src/user/manual/img/login-img-1.png
diff --git a/docs/src/user/manual/img/login-img-2.png b/docs/src/user/manual/img/login-img-2.png
diff --git a/docs/src/user/manual/img/login-img-3.png b/docs/src/user/manual/img/login-img-3.png
diff --git a/docs/src/user/manual/img/logout-img-1.png b/docs/src/user/manual/img/logout-img-1.png
diff --git a/docs/src/user/manual/img/logout-img-2.png b/docs/src/user/manual/img/logout-img-2.png
diff --git a/docs/src/user/manual/img/logout-img-3.png b/docs/src/user/manual/img/logout-img-3.png
diff --git a/docs/src/user/manual/img/password-reset-img-1.png b/docs/src/user/manual/img/password-reset-img-1.png
diff --git a/docs/src/user/manual/img/password-reset-img-2.png b/docs/src/user/manual/img/password-reset-img-2.png
diff --git a/docs/src/user/manual/img/password-reset-img-3.png b/docs/src/user/manual/img/password-reset-img-3.png
diff --git a/docs/src/user/manual/img/password-reset-img-4.png b/docs/src/user/manual/img/password-reset-img-4.png
diff --git a/docs/src/user/manual/img/password-reset-img-5.png b/docs/src/user/manual/img/password-reset-img-5.png
diff --git a/docs/src/user/manual/img/password-reset-img-6.png b/docs/src/user/manual/img/password-reset-img-6.png
diff --git a/docs/src/user/manual/img/signup-img-1.png b/docs/src/user/manual/img/signup-img-1.png
diff --git a/docs/src/user/manual/img/signup-img-10.png b/docs/src/user/manual/img/signup-img-10.png
diff --git a/docs/src/user/manual/img/signup-img-2.png b/docs/src/user/manual/img/signup-img-2.png
diff --git a/docs/src/user/manual/img/signup-img-3.png b/docs/src/user/manual/img/signup-img-3.png
diff --git a/docs/src/user/manual/img/signup-img-4.png b/docs/src/user/manual/img/signup-img-4.png
diff --git a/docs/src/user/manual/img/signup-img-5.png b/docs/src/user/manual/img/signup-img-5.png
diff --git a/docs/src/user/manual/img/signup-img-6.png b/docs/src/user/manual/img/signup-img-6.png
diff --git a/docs/src/user/manual/img/signup-img-7.png b/docs/src/user/manual/img/signup-img-7.png
diff --git a/docs/src/user/manual/img/signup-img-8.png b/docs/src/user/manual/img/signup-img-8.png
diff --git a/docs/src/user/manual/img/signup-img-9.png b/docs/src/user/manual/img/signup-img-9.png
diff --git a/docs/src/user/manual/index.md b/docs/src/user/manual/index.md
@@ -17,3 +17,19 @@ This section of the documentation describes every page in the application and
 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 provides a walkthrough of the sign-up process.
+
+**[Login](./login.md):** This provides a walkthrough of the login process.
+
+**[Log Out](./logout.md):** This provides a walkthrough of the sign-out process.
+
+**[Password Reset](./password-reset.md):** This provides a walkthrough of the password reset process.
+
+**[About](./about.md):** This provides a walkthrough of the about page.
+
+**[Contact](./contact.md):** This provides a walkthrough of the contact page.
+
+**[Help](./help.md):** This provides a walkthrough of the help page.
+
+**[Citation](./citation.md):** This provides a walkthrough of the citation page.
diff --git a/docs/src/user/manual/login.md b/docs/src/user/manual/login.md
@@ -0,0 +1,37 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Tim Sutton
+    - Jeremy Prior
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+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.
+#context_id: 1234
+---
+
+# Login
+
+[![Home Page](./img/login-img-1.png)](./img/login-img-1.png)
+
+* **LOG IN:** By clicking on this button user will be redirected to the login page.
+
+    [![Login Page](./img/login-img-2.png)](./img/login-img-2.png)
+
+* **Email:** Users must enter the email address associated with their registered account.
+
+* **Password:** Users must enter the password associated with their registered account.
+
+* **Forgot your password?:** Allows users to reset their password.
+
+* **Remember Me ✅:** Allows users to save their login credentials for future use.
+
+* **LOGIN:** After entering the correct email and password, users can click on this button to log in.
+
+    * If the email address or password is incorrect, user will encountered with this error.
+
+        [![Login Failed](./img/login-img-3.png)](./img/login-img-3.png)
+
+After successful login, user will be redirected to the map page.
diff --git a/docs/src/user/manual/logout.md b/docs/src/user/manual/logout.md
@@ -0,0 +1,27 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Tim Sutton
+    - Jeremy Prior
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+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.
+#context_id: 1234
+---
+# Log Out
+
+[![Home Page](./img/logout-img-1.png)](./img/logout-img-1.png)
+
+1. **LOGOUT:** Users can log out from the site by clicking on this button, which will redirect them to a logout confirmation page.
+
+[![Log Out Confirmation](./img/logout-img-2.png)](./img/logout-img-2.png)
+
+* Click on the `LOG OUT` button to confirm the logout action.
+
+This will redirects the users to the home page.
+
+[![Home Page](./img/logout-img-3.png)](./img/logout-img-3.png)
+
diff --git a/docs/src/user/manual/password-reset.md b/docs/src/user/manual/password-reset.md
@@ -0,0 +1,53 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Tim Sutton
+    - Jeremy Prior
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+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.
+#context_id: 1234
+---
+
+# Password Reset
+
+[![Home Page](./img/login-img-1.png)](./img/login-img-1.png)
+
+1. **LOGIN:** Click on this button to access the login page.
+
+[![Login Page](./img/password-reset-img-1.png)](./img/password-reset-img-1.png)
+
+1. **Forgot your Password?:** By clicking on this link user will be redirected to the password reset page.
+
+[![Password Reset Form](./img/password-reset-img-2.png)](./img/password-reset-img-2.png)
+
+1. **Email:** Users are required to enter the email address associated with their account.
+
+2. **Reset My Password:** Once the email is entered, click on this button to submit the password reset request.
+
+* After submitting the request this message will be displayed and a password link will be sent to the user's email.
+
+    [![Password Reset Request](./img/password-reset-img-3.png)](./img/password-reset-img-3.png)
+
+* User will receive an email with a password reset link.
+
+    [![Password Reset Email](./img/password-reset-img-4.png)](./img/password-reset-img-4.png)
+
+* Click on the password reset link to reset the password. This will redirect the user to the `CHANGE PASSWORD` page.
+
+    [![Change Password Page](./img/password-reset-img-5.png)](./img/password-reset-img-5.png)
+
+    **1. New Password:** Enter a new password for your account.
+
+    **2. New Password(again):** Re-enter the new password to confirm.
+
+    **3. Change Password:** Click on this button to submit the request.
+
+* After submission, a message will be displayed confirming that `Your password is now changed`.
+
+    [![Change Password Complete](./img/password-reset-img-6.png)](./img/password-reset-img-6.png)
+
+After completing the process, the user will be able to login with their new password.