[pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

docs/FAQ.md

@@ -1,4 +1,4 @@
-## :question: Frequently Asked Questions :question:
+## :question: Frequently Asked Questions :question
 
 ### For Users
 
@@ -7,13 +7,15 @@ Q: What is FMTM?
 **A:** FMTM stands for Field Monitoring Task Manager. It is a web-based
 application that facilitates remote monitoring of field activities for
 humanitarian organizations.
+
 <hr></hr>
 
 **Q:** Do I need to create an account to use the FMTM Web App?
 
 **A:** No, you can use the FMTM Web App without creating an account, but
 creating an account allows you to contribute to mapping projects and
 access additional features.
+
 <hr></hr>
 
 **Q:** How do I browse and select mapping projects on the FMTM Web App?
@@ -22,6 +24,7 @@ access additional features.
 clicking on the "Projects" tab and selecting a project of
 interest. You can view project details, tasks, and mapping data on the
 project page.
+
 <hr></hr>
 
 **Q:** How do I contribute to a mapping project on the FMTM Web App?
@@ -30,34 +33,39 @@ project page.
 create an account, select a project of interest, and choose a task to
 work on. You can then use the mapping tools provided to complete the
 task.
+
 <hr></hr>
 
 **Q:** Can I work on multiple mapping tasks at the same time on the FMTM Web App?
 
 **A:** Yes, you can work on multiple mapping tasks at the same time on the
 FMTM Web App, as long as you can commit the necessary time and effort
 to each task.
+
 <hr></hr>
 
 **Q:** How do I know if my mapping work on the FMTM Web App is accurate?
 
 **A:** The FMTM Web App has a validation process where other contributors
 review and validate the mapping work. This helps to ensure the
 accuracy of the mapping data.
+
 <hr></hr>
 
 **Q:** Can I provide feedback on a mapping project on the FMTM Web App?
 
 **A:** Yes, you can provide feedback on a mapping project on the FMTM Web
 App by leaving a comment on the project page or contacting the project
 manager.
+
 <hr></hr>
 
 **Q:** How do I download mapping data from a project on the FMTM Web App?
 
 **A:** To download mapping data from a project on the FMTM Web App, you
 can select the project of interest and click on the "Export" button on
 the project page.
+
 <hr></hr>
 
 **Q:** Can I use the mapping data from the FMTM Web App for my own research or projects?
@@ -66,6 +74,7 @@ the project page.
 available for use, but it is important to check the specific project
 requirements and licenses before using the data for your own research
 or projects.
+
 <hr></hr>
 
 ### For Contributors
@@ -75,19 +84,22 @@ or projects.
 **A:** The Field Mapping Tasking Manager (FMTM) is an online platform that
 allows contributors to participate in mapping projects related to
 humanitarian and development work.
+
 <hr></hr>
 
 **Q:** How can I become a contributor to the FMTM?
 
 **A:** To become a contributor to the FMTM, you can create an account on
 the platform and join a mapping project.
+
 <hr></hr>
 
 **Q:** Who can contribute to FMTM?
 
 **A:** Anyone can contribute to FMTM. It is an open-source project, and
 contributions from developers, designers, and other contributors are
 always welcome.
+
 <hr></hr>
 
 **Q:** What kind of contributions can I make to FMTM?
@@ -113,20 +125,23 @@ improvements.
 Translation: If you are fluent in a language other than English, you
 can contribute by translating the application or its documentation
 into your language.
+
 <hr></hr>
 
 **Q:** What technologies are used in FMTM?
 
 **A:** FMTM is built using several technologies, including Django,
 Postgres, Redis, Celery, and Vue.js. The codebase is written in
 Python, HTML, CSS, and JavaScript.
+
 <hr></hr>
 
 **Q:** How do I set up FMTM locally?
 
 **A:** To set up FMTM locally, you need to have Python, Postgres, Redis,
 and Node.js installed on your system. You can follow the instructions
 in the README file of the FMTM repository to set up the project.
+
 <hr></hr>
 
 **Q:** How can I report a bug or suggest a new feature for FMTM?
@@ -135,6 +150,7 @@ in the README file of the FMTM repository to set up the project.
 the FMTM repository on GitHub. Be sure to provide as much detail as
 possible, including steps to reproduce the bug, screenshots, or
 mockups for new features.
+
 <hr></hr>
 
 **Q:** How can I contribute to FMTM if I'm new to open source or web development?
@@ -146,20 +162,23 @@ documentation, asking questions in the community, and contributing to
 issues labeled as "good first issue." Additionally, you can join the
 FMTM community on Slack to connect with other contributors and get
 help with your contributions.
+
 <hr></hr>
 
 **Q:** What are the benefits of contributing to the FMTM?
 
 **A:** Contributing to the FMTM allows you to help with important
 humanitarian and development work, while also developing your mapping
 skills and knowledge.
+
 <hr></hr>
 
 **Q:** Do I need to have prior mapping experience to contribute to the FMTM?
 
 **A:** No, prior mapping experience is not required to contribute to the
 FMTM. The platform provides training and resources to help new
 contributors get started.
+
 <hr></hr>
 
 **Q:** How do I know which mapping project to join?
@@ -168,36 +187,35 @@ contributors get started.
 location, the organization sponsoring the project, and the mapping
 goals. Review the project information and choose a project that
 interests you.
+
 <hr></hr>
 
 **Q:** Can I work on multiple mapping projects at the same time?
 
 **A:** Yes, you can work on multiple mapping projects at the same
 time. However, it is important to ensure that you can commit the
 necessary time and effort to each project.
+
 <hr></hr>
 
 **Q:** How do I get feedback on my mapping work?
 
 **A:** The FMTM provides a validation process where other contributors
 review and provide feedback on mapping work. You can also contact
 project managers or experienced contributors for additional feedback.
+
 <hr></hr>
 
 **Q:** How can I improve my mapping skills?
 
 **A:** The FMTM provides training and resources to help you improve your
 mapping skills. You can also join mapping communities and forums to
 connect with other contributors and learn from their experiences.
+
 <hr></hr>
 
 **Q:** Can I use the mapping data for my own research or projects?
 
 **A:** The mapping data on the FMTM is generally open and available for
 use, but it is important to check the specific project requirements
 and licenses before using the data for your own research or projects.
-
-
-
-
-

docs/Guide-On-Improving-Documentation.md

@@ -9,6 +9,7 @@ documentation needed by **HOTOSM**. It also includes specific tips for
 improving already existing documentation.
 
 ## Goals
+
 1. Highlight the definitions of each type of documentation that are
    commonly used on Github.
 2. Provide a foundation to lay information on top of, in order to
@@ -27,19 +28,20 @@ documentation may include some Process documentation under the Usage
 section, demonstrating how to use that product. These 4 types in full,
 are as follows:
 
-- **Product Documentation** 
+- **Product Documentation**
 - **Project Documentation**
 - **System Documentation**
 - **Process Documentation**
 
 ### 1. Structure for Product Documentation
 
 Product documentation is the process of recording key information
-(almost everything you need to know) about a product,  including how
+(almost everything you need to know) about a product, including how
 to use it. Product documentation may have form of **Process
 documentation** within it (this will be further explained later on). A
 flexible and reusable structure of essential components of product
 documentation is as follows:
+
 - Overview
 - Introduction: What the product is, what it does, the target audience, etc.
 - Features: A breakdown of each integral part of the product, their
@@ -61,6 +63,7 @@ Project documentation is the process of recording the key project
 details that are needed to implement a project. It’s like a roadmap of
 what the project is and all necessary information about what it
 entails. Main structural components are in the following order:
+
 - Overview
 - Vision
 - Aim / Mission
@@ -71,7 +74,7 @@ entails. Main structural components are in the following order:
 - Access
 - Resources
 - Support / Guidelines
- 
+
 ### 3. Structure for System Documentation
 
 System documentation is an all-encompassing record of details of a
@@ -90,6 +93,7 @@ step. Process documentation is very useful in other documentation
 forms. As mentioned earlier, it can be used within **System**,
 **Product** or **Project** documentation, to explain a process. The
 format is usually:
+
 - Overview
 - Introduction
 - Explanation steps (breakdown of the task)
@@ -116,20 +120,20 @@ added to and built upon.
    documentation more user friendly and much easier to understand,
    since users come from all different backgrounds. For example:
 
-    “ODK incorporates a new functionality” can become “ODK has brought in a new feature”.
+   “ODK incorporates a new functionality” can become “ODK has brought in a new feature”.
 
-    “Field Mappers select (or are allocated) individual tasks within a
-    project’s AOI” could be changed to “Field Mappers choose or are
-    given tasks that are part of a project’s Areas Of Interest.”
+   “Field Mappers select (or are allocated) individual tasks within a
+   project’s AOI” could be changed to “Field Mappers choose or are
+   given tasks that are part of a project’s Areas Of Interest.”
 
 4. **Avoid long paragraphs**. Short paragraphs that pass a clear
-    message are less clumsy and flustering for readers. Breaking down
-    topics into little, easy to understand chunks, is more user
-    friendly.
+   message are less clumsy and flustering for readers. Breaking down
+   topics into little, easy to understand chunks, is more user
+   friendly.
 
 5. **Maintain a positive tone in the writing.**. Keep the text
    positive and informative. Avoid words like ‘obviously’ and
-   ‘basically’,  that may be interpreted as demeaning or
+   ‘basically’, that may be interpreted as demeaning or
    condescending. Do not expect readers to have a certain amount of
    knowledge on specific aspects, break down everything that needs to
    be broken down.
@@ -143,9 +147,9 @@ added to and built upon.
    documentation.This consistency includes but is not limited to
    elements like numbering, font styles, heading sizes, and spacing.
 
-    Using the same font for all headings and subheadings can help
-    readers quickly identify important sections of the
-    document. Similarly, using consistent spacing between paragraphs
-    and sections can make the document more visually appealing and
-    easier to follow. This helps to create a documentation that is
-    clear, effective, and easy to use.
+   Using the same font for all headings and subheadings can help
+   readers quickly identify important sections of the
+   document. Similarly, using consistent spacing between paragraphs
+   and sections can make the document more visually appealing and
+   easier to follow. This helps to create a documentation that is
+   clear, effective, and easy to use.