Documentation headers (#1007)

* Add header * Add reference to the How-To index file * Add content to the Map index file * Update the URL * Update the contact detail
kartoza · May 3, 2024 · 9dc70f7 · 9dc70f7
1 parent f4521fa
commit 9dc70f7
Show file tree

Hide file tree

Showing 39 changed files with 474 additions and 3 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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.