diff --git a/docs/src/administrator/index.md b/docs/src/administrator/index.md
index 99acd4a..7a7a723 100644
--- a/docs/src/administrator/index.md
+++ b/docs/src/administrator/index.md
@@ -12,7 +12,7 @@ license: the reforestation tool is made available to Global Evergreening Global
# For administrators
-This is the homepage for all administrator related documentation.
+This is the homepage for all administrator-related documentation.
The content is divided into two sections:
diff --git a/docs/src/developer/documentation/overview.md b/docs/src/developer/documentation/overview.md
index fb35a13..07444ad 100644
--- a/docs/src/developer/documentation/overview.md
+++ b/docs/src/developer/documentation/overview.md
@@ -19,27 +19,27 @@ This section provides an overview of how the documentation system works.
Welcome to the instructions for those wishing to contribute to our documentation!
-Our documentation system is based on the popular [mkdocs](https://www.mkdocs.org/) system. We encourage you to read the upstream documentation from mkdocs for the finer details of how mkdocs. In particular, read [this page](https://www.mkdocs.org/user-guide/writing-your-docs/) before you get to work. Mkdocs is not hard, but it may feel initially a little different if you are used to creating your documentation in word.
+Our documentation system is based on the popular [mkdocs](https://www.mkdocs.org/) system. We encourage you to read the upstream documentation from mkdocs for the finer details of how mkdocs. In particular, read [this page](https://www.mkdocs.org/user-guide/writing-your-docs/) before you get to work. Mkdocs is not hard, but it may feel initially a little different if you are used to creating your documentation in MSWord.
We use mkdocs because it has some great and useful features. Most especially:
* The code and the documentation are versioned together. This means that for whatever version of the code we have in our production release, we can be sure the documentation matches that release. We can also look back at changes over time through the version history when needed.
-* It can render beautiful static (not needing a backend server) web sites with great features like search, styling, intuitive navigation etc.
+* It can render beautiful static (not needing a backend server) websites with great features like search, styling, intuitive navigation etc.
* It can optionally render PDF documents from the same source markdown.
-* An ecosystem of plugins and themes makes mkdocs really flexible and extensible.
+* An ecosystem of plugins and themes makes mkdocs flexible and extensible.
### Some terminology
In our documentation, we have organised the information using a specific nomenclature:
-* **guide**: A guide is a multi-step workflow / tutorial that leads your through common activities.
+* **guide**: A guide is a multi-step workflow/tutorial that leads you through common activities.
* **manual**: A collection of documents that describe each part of the project in a matter of fact way without presupposing any specific workflow is being undertaken.
For each of the main topic areas (user, admin, developer, devops, api user) we provide guides and manuals as is appropriate.
### Organisation
-The documentation is broadly organised in the following structure. This structure may change over time as sections are added / moved / removed:
+The documentation is broadly organised in the following structure. This structure may change over time as sections are added/moved/removed:
```
src
@@ -65,12 +65,12 @@ src
Please follow these conventions when writing your documentation:
-1. Write file names in all lower case, with hyphens separating words (no spaces). e.g. ``important-file.md`` not ``Important File.md`` or other deviations.
+1. Write file names in all lowercase, with hyphens separating words (no spaces). e.g. ``important-file.md`` not ``Important File.md`` or other deviations.
2. Place the image files in the img folder adjacent to your content.
3. Do not abbreviate any words in file names - but try to use terse, descriptive names.
-4. Place your content into the appropriate place as outline in the structure above.
-5. Each file should only one level one heading e.g. ``# Page title``
-6. Headings and subheadings should be written as a terse phrase starting with a capital letter and subsequent words in lower case unless they are proper nouns. Do not place a colon after the heading.
+4. Place your content into the appropriate place as outlined in the structure above.
+5. Each file should have only one level one heading e.g. ``# Page title``
+6. Headings and subheadings should be written as a terse phrase starting with a capital letter and subsequent words in lowercase unless they are proper nouns. Do not place a colon after the heading.
7. Use unicode number markers to reference numbers in images e.g. 1️⃣
8. Every heading / sub-heading should have a single line underneath it summarising the content that will follow. This sentence will be used in the help center in the application to give the user a reference point for the text that will follow. It also makes the help text more consistent and readable.
9. For every section that images, the first image will be used as the thumbnail if the heading is referenced from the application.
@@ -114,7 +114,7 @@ Once you have committed your changes, 1️⃣ Click on the burger menu and then
Your fork of the repository will be opened in a new tab within your browser, navigate to that tab. Once there 1️⃣ ensure you are on the `main`, you should see how many commits ahead of the upstream branch you are, then 2️⃣ click on `Contribute`-> `Open pull request`.
-On the next screen, 1️⃣ give your pull request a meaningful title, 2️⃣ give additional details regarding changes made in the larger text box, then 3️⃣️ click on `Create pull request`. Also ensure you are creating a pull request to the upstream `main` branch from your `main` branch.
+On the next screen, 1️⃣ give your pull request a meaningful title, 2️⃣ give additional details regarding changes made in the larger text box, then 3️⃣️ click on `Create pull request`. Also, ensure you are creating a pull request to the upstream `main` branch from your `main` branch.
Once your pull request is opened you need to wait for it to be merged before you can open a new one.
@@ -141,7 +141,7 @@ license: This program is free software; you can redistribute it and/or modify it
The summary can be updated to include your name for documents you contribute to.
-The context_id is used to create a unique permalink to this document, and is optional. See further down in this document for more details.
+The context_id is used to create a unique permalink to this document and is optional. See further down in this document for more details.
### Navigation
@@ -150,7 +150,7 @@ All pages need to be added to the 'Nav' section of the `mkdocs-base.yml` file. T
`- "Navigating the map": users/guide/map-navigation.md`
-Sometimes you may not wish to have the new page displayed in the menu system (this can be useful when, for example, it is accessed via a link in another page. In these cases, leave the menu entry part blank e.g.
+Sometimes you may not wish to have the new page displayed in the menu system (this can be useful when, for example, it is accessed via a link on another page. In these cases, leave the menu entry part blank e.g.
`- "": users/guide/map-navigation.md`
@@ -197,7 +197,7 @@ Every page should have a help link on it that leads to the appropriate manual pa
3. In the metadata section at the top of the page, add the context id e.g. ``context_id: V4cVEFd2TmwYJVb5HvWRwa``
4. In your django view, set up your help button to point to the site url and your context id. e.g. ``https://siteurl/V4cVEFd2TmwYJVb5HvWRwa``
-Whenever the user visits the page using the UUID URL, they will be redirected to the correct page e.g. ``https://siteurl/login/``. This system protects us from file renaming and reorganising on the site, and ensures that the help link will always remain valid.
+Whenever the user visits the page using the UUID URL, they will be redirected to the correct page e.g. ``https://siteurl/login/``. This system protects us from file renaming and reorganising on the site and ensures that the help link will always remain valid.
### Generating PDFS
diff --git a/docs/src/developer/guide/architecture.md b/docs/src/developer/guide/architecture.md
index 921efa0..76baceb 100644
--- a/docs/src/developer/guide/architecture.md
+++ b/docs/src/developer/guide/architecture.md
@@ -11,7 +11,7 @@ license: the reforestation tool is made available to Global Evergreening Global
# System architecture
-In this section, we outline the system architecture using ER Diagrams, Software Component Diagrams etc. and key libraries / frameworks used in this project.
+In this section, we outline the system architecture using ER Diagrams, Software Component Diagrams etc. and key libraries/frameworks used in this project.
## Software components used
@@ -24,27 +24,27 @@ The following is a list, with brief descriptions, of the key components used in
|{: style="height:30px;width:30px"}| [ReactJS](https://react.dev/) | React lets you build user interfaces out of individual pieces called components. Create your own React components like `Thumbnail`, `LikeButton`, and `Video`. Then combine them into entire screens, pages, and apps.|
| {: style="height:30px;width:30px"} | [MUI](https://mui.com/)| Move faster with intuitive React UI tools. MUI offers a comprehensive suite of free UI tools to help you ship new features faster. Start with Material UI, our fully-loaded component library, or bring your own design system to our production-ready components. |
| {: style="height:30px;width:30px"} | [Docker](https://docker.com) | Accelerate how you build, share, and run applications. Docker helps developers build, share, and run applications anywhere — without tedious environment configuration or management. |
-| {: style="height:30px;width:30px"} | [Celery](https://docs.celeryq.dev) | Celery is a simple, flexible, and reliable distributed system to process vast amounts of messages, while providing operations with the tools required to maintain such a system. It’s a task queue with focus on real-time processing, while also supporting task scheduling. |
+| {: style="height:30px;width:30px"} | [Celery](https://docs.celeryq.dev) | Celery is a simple, flexible, and reliable distributed system to process vast amounts of messages while providing operations with the tools required to maintain such a system. It’s a task queue with a focus on real-time processing, while also supporting task scheduling. |
| {: style="height:30px;width:30px"} | [Celery Beat](https://github.com/celery/django-celery-beat) | This extension enables you to store the periodic task schedule in your database. The periodic tasks can be managed from the Django Admin interface, where you can create, edit and delete periodic tasks and how often they should run. |
| {: style="height:30px;width:30px"} | [Django Rest Framework](https://www.django-rest-framework.org/) | Django REST framework is a powerful and flexible toolkit for building Web APIs. |
| {: style="height:30px;width:30px"} | [MapLibre](https://maplibre.org/) | Open-source mapping libraries for web and mobile app developers. |
| {: style="height:30px;width:30px"} | []() | deck.gl is a WebGL-powered framework for visual exploratory data analysis of large datasets. |
| {: style="height:30px;width:30px"} | [PostGIS](https://postgis.net/) | PostGIS extends the capabilities of the PostgreSQL relational database by adding support storing, indexing and querying geographic data. |
-| {: style="height:30px;width:30px"} | [PostgreSQL](https://www.postgresql.org/) | PostgreSQL is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance. |
+| {: style="height:30px;width:30px"} | [PostgreSQL](https://www.postgresql.org/) | PostgreSQL is a powerful, open-source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance. |
| {: style="height:30px;width:30px"} | [Tegola](https://tegola.io/) | An open source vector tile server written in Go, Tegola takes geospatial data and slices it into vector tiles that can be efficiently delivered to any client. |
-| {: style="height:30px;width:30px"} | [GDAL](https://gdal.org) | GDAL is a translator library for raster and vector geospatial data formats that is released under an MIT style Open Source License by the Open Source Geospatial Foundation. As a library, it presents a single raster abstract data model and single vector abstract data model to the calling application for all supported formats. It also comes with a variety of useful command line utilities for data translation and processing. |
+| {: style="height:30px;width:30px"} | [GDAL](https://gdal.org) | GDAL is a translator library for raster and vector geospatial data formats that is released under an MIT style Open Source License by the Open Source Geospatial Foundation. As a library, it presents a single raster abstract data model and a single vector abstract data model to the calling application for all supported formats. It also comes with a variety of useful command line utilities for data translation and processing. |
## Docker components
The following diagram represents the docker containers, ports and volumes that are used to compose this platform.
-
+
![Architecture Docker Diagram]()
## ER diagram
-The following diagram represents all of the database entities that are created by the Django ORM (Object Relational Mapper). Right click the image and open it in its own tab to see it at full resolution.
+The following diagram represents all of the database entities that are created by the Django ORM (Object Relational Mapper). Right-click the image and open it in its own tab to see it at full resolution.
![Architecture ERD]()
diff --git a/docs/src/developer/guide/building.md b/docs/src/developer/guide/building.md
index 7d99d1e..0bb7fa0 100644
--- a/docs/src/developer/guide/building.md
+++ b/docs/src/developer/guide/building.md
@@ -15,17 +15,17 @@ This section covers the process of building and running the application from you
🚩 Make sure you have gone through the [IDE Setup Process](ide-setup.md) before following these notes.
-Press `Ctrl -> P` 1️⃣ and then `>`and search for `Rebuild`. Select `Dev Containers: Rebuild and Reopen in Container`2️⃣. This will essentially mount your code tree inside a docker container and switch the development context of VSCode to be inside the container where all of the python etc. dependencies will be installed.
+Press `Ctrl -> P` 1️⃣ and then `>` and search for `Rebuild`. Select `Dev Containers: Rebuild and Reopen in Container`2️⃣. This will essentially mount your code tree inside a docker container and switch the development context of VSCode to be inside the container where all of the python etc. dependencies will be installed.
-Once the task is running, a notification 1️⃣ will be shown in the bottom right of the VSCode window. Clicking in the notification will show you the setup progress 2️⃣. Note that this make take quite a while depending on the internet bandwidth you have and the CPU power of your machine.
+Once the task is running, a notification 1️⃣ will be shown in the bottom right of the VSCode window. Clicking on the notification will show you the setup progress 2️⃣. Note that this may take quite a while depending on the internet bandwidth you have and the CPU power of your machine.
## Open a dev container terminal
-Open terminal within the dev container context by clicking the `+`icon in the terminal pane 1️⃣. The new terminal 2️⃣ will show up in the list of running terminals 3️⃣
+Open the terminal within the dev container context by clicking the `+`icon in the terminal pane 1️⃣. The new terminal 2️⃣ will show up in the list of running terminals 3️⃣
@@ -52,7 +52,7 @@ cd /home/web/project/django_project
python manage.py createsuperuser
```
-During this process you will be prompted for your user name (defaults to root), email address and a password (which you need to confirm). Complete these as needed.
+During this process, you will be prompted for your user name (defaults to root), email address and a password (which you need to confirm). Complete these as needed.
## Viewing your test instance
diff --git a/docs/src/developer/guide/configuration.md b/docs/src/developer/guide/configuration.md
index 4200de9..4e42166 100644
--- a/docs/src/developer/guide/configuration.md
+++ b/docs/src/developer/guide/configuration.md
@@ -46,8 +46,8 @@ password : admin
## Set up different environment
-To set up different environment, for example the Default credential, or the port of server, open **deployment/.env**.
-You can check the description below for each of variable.
+To set up a different environment, for example, the Default credential, or the port of server, open **deployment/.env**.
+You can check the description below for each variable.
```
COMPOSE_PROJECT_NAME=[PROJECT_NAME]
@@ -56,7 +56,7 @@ DJANGO_TAG=0.0.1 -> Change this for different django image
DJANGO_DEV_TAG=0.0.1 -> Change this for different django dev image
# Environments
-DJANGO_SETTINGS_MODULE=core.settings.prod -> Change this to use different django config file
+DJANGO_SETTINGS_MODULE=core.settings.prod -> Change this to use a different django config file
ADMIN_USERNAME=admin -> Default admin username
ADMIN_PASSWORD=admin -> Default admin password
ADMIN_EMAIL=admin@example.com -> Default admin email
@@ -67,7 +67,7 @@ HTTP_PORT=80 -> Change the port of nginx
DATABASE_NAME=django -> Default database name
DATABASE_USERNAME=docker -> Default database username
DATABASE_PASSWORD=docker -> Default database password
-DATABASE_HOST=db -> Default database host. Change this if you use cloud database or any new docker container.
+DATABASE_HOST=db -> Default database host. Change this if you use a cloud database or any new docker container.
RABBITMQ_HOST=rabbitmq
# Onedrive
@@ -75,4 +75,4 @@ PUID=1000
PGID=1000
```
-After you change the desired variable and do `make up`. It will rerun the project with new environment.
+After you change the desired variable, run `make up`. This will restart the project with the updated environment.
diff --git a/docs/src/developer/guide/ide-setup.md b/docs/src/developer/guide/ide-setup.md
index fe68d5e..c12a97a 100644
--- a/docs/src/developer/guide/ide-setup.md
+++ b/docs/src/developer/guide/ide-setup.md
@@ -17,7 +17,7 @@ This section outlines the process for configuring your IDE for development.
## VS Code setup
-Open the project in VSCode (1️⃣, 2️⃣) by navigating the the place on your file system where you checked out the code in the pre-requisites step above (3️⃣).
+Open the project in VSCode (1️⃣, 2️⃣) by navigating the place on your file system where you checked out the code in the pre-requisites step above (3️⃣).
@@ -55,7 +55,7 @@ Rename the file to `docker-compose.override.yml`
-Initially you will not need to change anything in this file, though you may want to take a look through the various configurations provided here if you want to tweak your local setup.
+Initially, you will not need to change anything in this file, though you may want to take a look through the various configurations provided here if you want to tweak your local setup.
Now that you have your IDE set up, we can move on to [building the project](building.md).
@@ -75,7 +75,7 @@ Requirements:
1. Go to File -> Settings -> Project -> Project Interpreter. Then click on the cog -> add
-2. Go to the ssh interpreter tab and fill in the form as below
+2. Go to the ssh interpreter tab and fill in the form as shown below
3. Click next and fill in **docker** as the password
@@ -87,7 +87,7 @@ Requirements:
5. After you click finish, it will show all of the packages like below.
-6. In current page, click **path mappings**, click + button and put local path to where the project (django-project folder) and remote path is like below. and click oK.
+6. In the current page, click **path mappings**, click the + button and put the local path to where the project (django-project folder) and the remote path are like below. and click OK.
Now the interpreter is done. When we restart the machine, we need to do `make up` to run the project.
@@ -103,25 +103,25 @@ After the interpreter is done, we need configuration to run the project in devel
-3. It will show the form and fill like below.
+3. It will show the form and fill it as shown below.
-4. Don't click the OK yet, but click **Environment Variables** and add environments like below (by clicking + button).
+4. Don't click the OK yet, but click **Environment Variables** and add environments as shown below (by clicking the + button).
5. After that, click OK.
-6. Now we need to run the server by clicking **go** button in below image.
+6. Now we need to run the server by clicking **go** button in the below image.
-7. When we click the **go** button, pycharm will run a process until like image below.
+7. When we click the **go** button, pycharm will run a process as shown in the image below.
8. Now it is done. We can access the development server in [http://localhost:2000/](http://localhost:2000/)
-This development mode is DEBUG mode, and also whenever we change the code, the site will also change in runtime.
+This development mode is DEBUG mode, and whenever we change the code, the site will also change in runtime.
-For more information how to set up on pycharm, please visit [Using a Docker Compose-Based Python Interpreter in PyCharm](https://kartoza.com/en/blog/using-docker-compose-based-python-interpreter-in-)
+For more information on how to set up on pycharm, please visit [Using a Docker Compose-Based Python Interpreter in PyCharm](https://kartoza.com/en/blog/using-docker-compose-based-python-interpreter-in-)
## Quick setup guide
@@ -161,7 +161,7 @@ cp docker-compose.override.template.yml docker-compose.override.yml
After that,
- open new terminal
-- on folder root of project, do
+- on folder root of the project, do
```
make frontend-dev
@@ -184,7 +184,7 @@ Wait until it is on.
The web can be accessed using `http://localhost:2000/`
-If the web is taking long time to load, restart project-name_dev container by `make dev-reload`.
+If the web is taking a long time to load, restart project-name_dev container by `make dev-reload`.
The sequence should be `make frontend-dev`, after that run or restart project-name_dev.
To stop dev:
@@ -193,7 +193,7 @@ To stop dev:
make dev-kill
```
-To reload container:
+To reload the container:
```
make dev-reload
diff --git a/docs/src/developer/guide/workflows.md b/docs/src/developer/guide/workflows.md
index aac3c9a..45574b0 100644
--- a/docs/src/developer/guide/workflows.md
+++ b/docs/src/developer/guide/workflows.md
@@ -18,7 +18,7 @@ license: the reforestation tool is made available to Global Evergreening Global
- Wait for it to be added to a Sprint
- Functional Tests
- Playwright Tests
-- Write end user documentation
+- Write end-user documentation
## Fixing a bug
@@ -36,4 +36,4 @@ Follow our [Commit message conventions](./templates/commit-message-convention.md
### Pull request template
If it has related issues, add links to the issues(like `#123`) in the description.
-Fill in the [Pull Request template](./templates/pull-request-template.md) by check your case.
+Fill in the [Pull Request template](./templates/pull-request-template.md) by checking your case.
diff --git a/docs/src/user/Appendix1.md b/docs/src/user/Appendix1.md
index 2ffe262..c939a12 100644
--- a/docs/src/user/Appendix1.md
+++ b/docs/src/user/Appendix1.md
@@ -140,7 +140,7 @@ The original content format of the forest, grassland and wetland exclusion masks
**4.4.1 Forest and Grassland Exclusion Mask Modifications**
-Both the forest and grassland exclusion masks have been content modified to align with a minimum feature area of 0.5 Ha. This 0.5 Ha area is equivalent to 8 raster cells when raster cell resolution is equivalent to 25 x 25m. All exclusion content classified cells that are considered interconnected clusters based on shared cell edges or cell corners have been removed from the exclusion mask content. This spatially cleaning process also results in a “cleaner” exclusion area coverage, resulting from the removal of small, isolated exclusion cells, commonly referred to as “salt-and-pepper” data pattern noise. No change has been made to any potential re-afforestation areas (not covered by exclusion mask content), regardless of the areas involved.
+Both the forest and grassland exclusion masks have been content modified to align with a minimum feature area of 0.5 Ha. This 0.5 Ha area is equivalent to 8 raster cells when raster cell resolution is equivalent to 25 x 25m. All exclusion content classified cells that are considered interconnected clusters based on shared cell edges or cell corners have been removed from the exclusion mask content. This spatial cleaning process also results in a “cleaner” exclusion area coverage, resulting from the removal of small, isolated exclusion cells, commonly referred to as “salt-and-pepper” data pattern noise. No change has been made to any potential re-afforestation areas (not covered by exclusion mask content), regardless of the areas involved.
Both the modified forest and grassland masks have had all overlapping areas with the wetland mask removed, so that all forest, grassland and wetland masks are all spatially exclusive against each other.
@@ -149,8 +149,8 @@ Both the modified forest and grassland masks have had all overlapping areas with
The wetland exclusion mask has been content modified to better represent landscape contiguous
(wetland) features, and remove model-generated “salt & pepper” data pattern noise. Specifically,
this has involved the in-filling of small non-classified data “holes” within and surrounded by wetland
-feature areas (up to 1 ha in extent), and removal of single, isolated wetland-classified cells. This
-spatially cleaning process also results in a “cleaner”, more homogenous representation of wetland
+feature areas (up to 1 ha in extent), and the removal of single, isolated wetland-classified cells. This
+spatial cleaning process also results in a “cleaner”, more homogenous representation of wetland
areas across the project landscape. It also excluded model generated “islands” of possible
reforestation sites from within wetland areas.
@@ -160,7 +160,7 @@ Project Zone.
Figure 3. Forest, Grassland and Wetland exclusion masks for the Malawi-south Project Zone extent,
-with close-up detail. Remaining grey background areas are available for reafforestation.
+with close-up detail. The remaining grey background areas are available for reafforestation.
Table 2. Modelling rules applied to the time-series LC data to determine the Forest and Grassland exclusion areas.
diff --git a/docs/src/user/guide/gea-reforestation-tool.md b/docs/src/user/guide/gea-reforestation-tool.md
index 4a5ce3f..f031e77 100644
--- a/docs/src/user/guide/gea-reforestation-tool.md
+++ b/docs/src/user/guide/gea-reforestation-tool.md
@@ -188,7 +188,7 @@ After selecting the desired project instance, a `Project Instance Attributes` po
- **Report Author :** Name of the person generating the report.
-- **Project :** Select the origin of the project from dropdown menu.
+- **Project :** Select the origin of the project from the dropdown menu.
- **Cencel :** Click on the `Cancel` button to stop the process.
- **Save :** Click on the `Save` button to complete the process.