diff --git a/docs/src/about/index.md b/docs/src/about/index.md index 9e53f967d..5e833465b 100644 --- a/docs/src/about/index.md +++ b/docs/src/about/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # About ## Contributors diff --git a/docs/src/administrator/admin.md b/docs/src/administrator/admin.md index fe70a5a09..a1ddcee7b 100644 --- a/docs/src/administrator/admin.md +++ b/docs/src/administrator/admin.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Admin Profile Option ## Introduction diff --git a/docs/src/administrator/django-admin.md b/docs/src/administrator/django-admin.md index 8bdceb5f7..e8d14acb7 100644 --- a/docs/src/administrator/django-admin.md +++ b/docs/src/administrator/django-admin.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Django Administration Site This site is the administration site for the miniSASS platform, and only specific superusers can access it and in turn have the ability to make changes on it. diff --git a/docs/src/administrator/index.md b/docs/src/administrator/index.md index 164f1e3b9..9217209c3 100644 --- a/docs/src/administrator/index.md +++ b/docs/src/administrator/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Administrator manual This section of documentation relates to Administrative users abilities on the platform. It consistes of: diff --git a/docs/src/developer/authentication.md b/docs/src/developer/authentication.md index 1eb87ffea..ab57435a8 100644 --- a/docs/src/developer/authentication.md +++ b/docs/src/developer/authentication.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Authentication API ## Our system uses the Django Rest Framework Authentication Package diff --git a/docs/src/developer/index.md b/docs/src/developer/index.md index bdaf52215..019fa47b0 100644 --- a/docs/src/developer/index.md +++ b/docs/src/developer/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Developer Documentation List of Developer documents: diff --git a/docs/src/developer/install.md b/docs/src/developer/install.md index 638c9f6fd..c67361bd3 100644 --- a/docs/src/developer/install.md +++ b/docs/src/developer/install.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Setting up a Local Development Environment ## Prerequisites diff --git a/docs/src/developer/observations.md b/docs/src/developer/observations.md index 060233e04..5dd96b1ca 100644 --- a/docs/src/developer/observations.md +++ b/docs/src/developer/observations.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Observations and Images API Documentation The Observations API facilitates users in creating observations for various sites, allowing the specification of existing site IDs or the creation of new sites if they are not available. Additionally, it enables retrieval of recent observations, access to all observations, fetching a single observation, and other CRUD (Create, Retrieve, Update, Delete) operations. diff --git a/docs/src/developer/profile.md b/docs/src/developer/profile.md index 36748414b..60d6b256c 100644 --- a/docs/src/developer/profile.md +++ b/docs/src/developer/profile.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Profile API ## Description diff --git a/docs/src/developer/sites.md b/docs/src/developer/sites.md index a92fe3759..ecee2db4d 100644 --- a/docs/src/developer/sites.md +++ b/docs/src/developer/sites.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Sites API ## Description diff --git a/docs/src/index.md b/docs/src/index.md index e0c775f58..4b8734f4b 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Welcome to MiniSASS ![Landing Page](./img/landing_page.png) diff --git a/docs/src/user/guide/forgot-password.md b/docs/src/user/guide/forgot-password.md index 10a7d0d30..c5c427efa 100644 --- a/docs/src/user/guide/forgot-password.md +++ b/docs/src/user/guide/forgot-password.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # miniSASS Forgot Password Page User Guide Welcome to the miniSASS Forgot Password Guide. In this guide, I'll walk you through the steps to reset your password if you've forgotten it. diff --git a/docs/src/user/guide/index.md b/docs/src/user/guide/index.md index c9e7b425e..4e7f7aacb 100644 --- a/docs/src/user/guide/index.md +++ b/docs/src/user/guide/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # miniSASS User Guide Welcome to the miniSASS user guide. In this section of the documentation, we aim to show users how to utilise the platform effectively, use maps and so forth. Here is a brief overview of the content provided here: diff --git a/docs/src/user/guide/profile.md b/docs/src/user/guide/profile.md index 68528bcfd..0d45bb5ca 100644 --- a/docs/src/user/guide/profile.md +++ b/docs/src/user/guide/profile.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # miniSASS Profile User Guide Welcome to the Profile user manual. This guide is designed to help users navigate and make the most of the profile experience. The profile page allows users to manage their personal information, customise settings, and access various features. Follow the instructions below to explore and use the profile form efficiently. diff --git a/docs/src/user/guide/register-login-logout.md b/docs/src/user/guide/register-login-logout.md index 14e4b0191..8f065eb68 100644 --- a/docs/src/user/guide/register-login-logout.md +++ b/docs/src/user/guide/register-login-logout.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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: Registration, Login, and Logout on miniSASS ## How do I register on the site? diff --git a/docs/src/user/index.md b/docs/src/user/index.md index f45689025..c1b9d79d2 100644 --- a/docs/src/user/index.md +++ b/docs/src/user/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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 Documentation This is the homepage for all user related documentation. diff --git a/docs/src/user/manual/contact-us.md b/docs/src/user/manual/contact-us.md index 9adcab30c..0d4030e16 100644 --- a/docs/src/user/manual/contact-us.md +++ b/docs/src/user/manual/contact-us.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Contact Form User Manual ## Introduction diff --git a/docs/src/user/manual/how-to/how-to.md b/docs/src/user/manual/how-to/how-to.md index 80901a9fc..48b4664bb 100644 --- a/docs/src/user/manual/how-to/how-to.md +++ b/docs/src/user/manual/how-to/how-to.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # How To User Manual ## Introduction diff --git a/docs/src/user/manual/how-to/index.md b/docs/src/user/manual/how-to/index.md index cf967232f..ce42e24f4 100644 --- a/docs/src/user/manual/how-to/index.md +++ b/docs/src/user/manual/how-to/index.md @@ -1,2 +1,16 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # How To - \ No newline at end of file + + +* **[How To:](./how-to.md)** This page explains how to use the `miniSASS` tool and its functionalities in detail. \ No newline at end of file diff --git a/docs/src/user/manual/index.md b/docs/src/user/manual/index.md index 49bd6d315..44e4bc9f7 100644 --- a/docs/src/user/manual/index.md +++ b/docs/src/user/manual/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # miniSASS User Manual Welcome to miniSASS diff --git a/docs/src/user/manual/landing-page.md b/docs/src/user/manual/landing-page.md index c437f0e34..5b4a0d00f 100644 --- a/docs/src/user/manual/landing-page.md +++ b/docs/src/user/manual/landing-page.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Landing Page User Manual ## Overview diff --git a/docs/src/user/manual/login-logout/forgot-password.md b/docs/src/user/manual/login-logout/forgot-password.md index 004d4a7f4..759bb5e2f 100644 --- a/docs/src/user/manual/login-logout/forgot-password.md +++ b/docs/src/user/manual/login-logout/forgot-password.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # miniSASS Forgot Password Page User Manual Welcome to the miniSASS Forgot Password page! Follow the steps below to reset your forgotten password. diff --git a/docs/src/user/manual/login-logout/index.md b/docs/src/user/manual/login-logout/index.md index 1de1fb788..259e0519c 100644 --- a/docs/src/user/manual/login-logout/index.md +++ b/docs/src/user/manual/login-logout/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Login-Logout This section of documentation pertains to logging in, logging out, and dealing with a user's password. It consists of: diff --git a/docs/src/user/manual/login-logout/login.md b/docs/src/user/manual/login-logout/login.md index 637f9fe4e..f394a7a99 100644 --- a/docs/src/user/manual/login-logout/login.md +++ b/docs/src/user/manual/login-logout/login.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Login Page User Manual Welcome to miniSASS login user manual. This user manual will walk you through the login process on miniSASS. diff --git a/docs/src/user/manual/login-logout/logout.md b/docs/src/user/manual/login-logout/logout.md index bfc3e9f24..f3e44bdb2 100644 --- a/docs/src/user/manual/login-logout/logout.md +++ b/docs/src/user/manual/login-logout/logout.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Logout User Manual ## Introduction diff --git a/docs/src/user/manual/login-logout/reset-password-email.md b/docs/src/user/manual/login-logout/reset-password-email.md index 43bc1abc4..34440aec6 100644 --- a/docs/src/user/manual/login-logout/reset-password-email.md +++ b/docs/src/user/manual/login-logout/reset-password-email.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Reset Password Email & Update Password User Manual Welcome to the miniSASS Reset Password page! Follow these steps to reset your password. diff --git a/docs/src/user/manual/map/index.md b/docs/src/user/manual/map/index.md index 5569662df..09b54fdcf 100644 --- a/docs/src/user/manual/map/index.md +++ b/docs/src/user/manual/map/index.md @@ -1,6 +1,19 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Map Pages This section of documentation pertains to the map that users interact with on the platform. It consists of: -* **[The Map:](./map.md)** -* **[Recent Observations:](./recent-observation.md)** +* **[The Map:](./map.md)** This section explains the basic layout and functions of the map interface, helping users understand how to navigate the map efficiently. + +* **[Recent Observations:](./recent-observation.md)** This page explains how users can view recent observations. diff --git a/docs/src/user/manual/map/map.md b/docs/src/user/manual/map/map.md index f601bfd4d..3ab6bc2e8 100644 --- a/docs/src/user/manual/map/map.md +++ b/docs/src/user/manual/map/map.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Map Page User Manual ## Introduction diff --git a/docs/src/user/manual/map/recent-observation.md b/docs/src/user/manual/map/recent-observation.md index 7ba1dfc06..11078155f 100644 --- a/docs/src/user/manual/map/recent-observation.md +++ b/docs/src/user/manual/map/recent-observation.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Recent Observation User Manual ## Introduction: diff --git a/docs/src/user/manual/register/activate-account.md b/docs/src/user/manual/register/activate-account.md index b247a880c..7d59f6b02 100644 --- a/docs/src/user/manual/register/activate-account.md +++ b/docs/src/user/manual/register/activate-account.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Activate Account User Manual ## Activate Account Email diff --git a/docs/src/user/manual/register/index.md b/docs/src/user/manual/register/index.md index 872904ec7..b0dc3c292 100644 --- a/docs/src/user/manual/register/index.md +++ b/docs/src/user/manual/register/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Register diff --git a/docs/src/user/manual/register/register.md b/docs/src/user/manual/register/register.md index afde82af2..940824956 100644 --- a/docs/src/user/manual/register/register.md +++ b/docs/src/user/manual/register/register.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Register Page User Manual ## Introduction diff --git a/docs/src/user/manual/upload/add-records.md b/docs/src/user/manual/upload/add-records.md index 61e23c2b3..13aacc8b7 100644 --- a/docs/src/user/manual/upload/add-records.md +++ b/docs/src/user/manual/upload/add-records.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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 Manual Add Record Form ## Introduction diff --git a/docs/src/user/manual/upload/index.md b/docs/src/user/manual/upload/index.md index a072e068d..593fa8741 100644 --- a/docs/src/user/manual/upload/index.md +++ b/docs/src/user/manual/upload/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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 manual Upload This section of documentation pertains to user data uploads. It consists of: diff --git a/docs/src/user/manual/upload/score.md b/docs/src/user/manual/upload/score.md index 6e87b410a..973454bf6 100644 --- a/docs/src/user/manual/upload/score.md +++ b/docs/src/user/manual/upload/score.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Score Page User Manual ## Introduction diff --git a/docs/src/user/manual/user-profile/index.md b/docs/src/user/manual/user-profile/index.md index 1c635ce6e..4456cb208 100644 --- a/docs/src/user/manual/user-profile/index.md +++ b/docs/src/user/manual/user-profile/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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 Profile diff --git a/docs/src/user/manual/user-profile/profile.md b/docs/src/user/manual/user-profile/profile.md index 300ca2e76..62133b7b8 100644 --- a/docs/src/user/manual/user-profile/profile.md +++ b/docs/src/user/manual/user-profile/profile.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Profile Form User Manual ## Introduction diff --git a/docs/src/user/manual/user-profile/recent-activity.md b/docs/src/user/manual/user-profile/recent-activity.md index 2717cc524..c583cc1ee 100644 --- a/docs/src/user/manual/user-profile/recent-activity.md +++ b/docs/src/user/manual/user-profile/recent-activity.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Recent Activity User Manual ## Introduction diff --git a/docs/src/user/quickstart/index.md b/docs/src/user/quickstart/index.md index 3d1f57e8b..35fcc9f1b 100644 --- a/docs/src/user/quickstart/index.md +++ b/docs/src/user/quickstart/index.md @@ -1,3 +1,15 @@ +--- +title: miniSASS +summary: The mini stream assessment scoring system (miniSASS) is a simple and accessible citizen science tool for monitoring the water quality and health of stream and river systems. You collect a sample of aquatic macroinvertebrates (small, but large enough to see animals with no internal skeletons) from a site in a stream or river. The community of these aquatic macroinvertebrates present then tells you about the water quality and health of the stream or river based on the concept that different groups of aquatic macroinvertebrates have different tolerances and sensitivities to disturbance and pollution. + - Jeremy Prior + - Ketan Bamniya +date: 27-11-2023 +some_url: https://minisass.org/ +copyright: Copyright 2023, miniSASS +contact: nicholas@groundtruth.co.za, info@minisass.org +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. +--- + # Quick Start Guide Begin by reviewing the `Quick Start Guide` for a seamless introduction to the miniSASS. This guide provides step-by-step instructions to help you set up your account, navigate the interface, and start using our services efficiently.