Merge pull request #6191 from robsavoye/mkdocs

Add Mkdocs support

docs/LICENSE.md

@@ -0,0 +1 @@
+../LICENSE.md

docs/about.md

@@ -0,0 +1,39 @@
+# Tasking Manager
+
+[![hotosm](https://dl.circleci.com/status-badge/img/gh/hotosm/tasking-manager/tree/develop.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/hotosm/tasking-manager/tree/develop)
+[![TM Backend on Quay](https://quay.io/repository/hotosm/tasking-manager/status "Tasking Manager Backend Build")](https://quay.io/repository/hotosm/tasking-manager)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=hotosm_tasking-manager&metric=alert_status)](https://sonarcloud.io/dashboard?id=hotosm_tasking-manager)
+
+[<img src="images/screenshot.jpg" />](images/screenshot.jpg)
+
+The most popular tool for teams to coordinate mapping on OpenStreetMap. With this web application, an area of interest can be defined and divided up into smaller tasks that can be completed rapidly. It shows which areas need to be mapped and which areas need a review for quality assurance. You can see the tool in action: log into the widely used [HOT Tasking Manager](https://tasks.hotosm.org/) and start mapping.
+
+This is Free and Open Source Software. You are welcome to use the code and set up your own instance. The Tasking Manager has been initially designed and built by and for the [Humanitarian OpenStreetMap Team](https://www.hotosm.org/), and is nowadays used by many communities and organizations.
+
+## Get involved!
+
+* Start by reading our [Code of conduct](https://github.com/hotosm/tasking-manager/blob/develop/docs/code_of_conduct.md)
+* Get familiar with our [contributor guidelines](https://github.com/hotosm/tasking-manager/blob/develop/docs/contributing.md) explaining the different ways in which you can support this project! We need your help!
+* Join the Tasking Manager Collective Meet up - an opportunity to meet other Tasking Manager contributors. The meet ups take place on the second Wednesday of the month at 9:00 or 15:00UTC! Register to receive a calendar invite: https://bit.ly/3s6ntmV or join directly via this link: https://meet.jit.si/TaskingManagerCollectiveMeetUp
+* Read the monthly update blogs on [OSM Discourse](https://community.openstreetmap.org/c/general/38/all).
+
+## Product Roadmap
+We have included below a [high level roadmap/plan](https://github.com/orgs/hotosm/projects/28/) [subject to change] that can be used as an overview.
+
+
+## Developers
+
+* [Understand the code](./docs/developers/understanding-the-code.md)
+* [Setup the TM for development](./docs/developers/development-setup.md)
+* [Learn about versions and releases](./docs/developers/versions-and-releases.md)
+* Help us and submit [pull requests](https://github.com/hotosm/tasking-manager/pulls)
+
+## Instances
+* [HOT Tasking Manager (production)](https://tasks.hotosm.org)
+* [HOT Tasking Manager (staging)](https://tasks-stage.hotosm.org)
+* [TeachOSM](https://tasks.teachosm.org/)
+* [OpenStreetMap Indonesia](https://tasks-indonesia.hotosm.org/)
+* [OpenStreetMap US](https://tasks.openstreetmap.us/)
+* [Map My Kerala](https://mapmykerala.in/)
+* [OpenHistoricalMap](https://tasks.openhistoricalmap.org)
+* [Oceania Tasking Manager](https://tasks.smartcitiestransport.com/)

docs/index.md

@@ -0,0 +1,39 @@
+# Tasking Manager
+
+[![hotosm](https://dl.circleci.com/status-badge/img/gh/hotosm/tasking-manager/tree/develop.svg?style=shield)](https://dl.circleci.com/status-badge/redirect/gh/hotosm/tasking-manager/tree/develop)
+[![TM Backend on Quay](https://quay.io/repository/hotosm/tasking-manager/status "Tasking Manager Backend Build")](https://quay.io/repository/hotosm/tasking-manager)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=hotosm_tasking-manager&metric=alert_status)](https://sonarcloud.io/dashboard?id=hotosm_tasking-manager)
+
+[<img src="images/screenshot.jpg" />](./screenshot.jpg)
+
+The most popular tool for teams to coordinate mapping on OpenStreetMap. With this web application, an area of interest can be defined and divided up into smaller tasks that can be completed rapidly. It shows which areas need to be mapped and which areas need a review for quality assurance. You can see the tool in action: log into the widely used [HOT Tasking Manager](https://tasks.hotosm.org/) and start mapping.
+
+This is Free and Open Source Software. You are welcome to use the code and set up your own instance. The Tasking Manager has been initially designed and built by and for the [Humanitarian OpenStreetMap Team](https://www.hotosm.org/), and is nowadays used by many communities and organizations.
+
+## Get involved!
+
+* Start by reading our [Code of conduct](https://github.com/hotosm/tasking-manager/blob/develop/docs/code_of_conduct.md)
+* Get familiar with our [contributor guidelines](https://github.com/hotosm/tasking-manager/blob/develop/docs/contributing.md) explaining the different ways in which you can support this project! We need your help!
+* Join the Tasking Manager Collective Meet up - an opportunity to meet other Tasking Manager contributors. The meet ups take place on the second Wednesday of the month at 9:00 or 15:00UTC! Register to receive a calendar invite: https://bit.ly/3s6ntmV or join directly via this link: https://meet.jit.si/TaskingManagerCollectiveMeetUp
+* Read the monthly update blogs on [OSM Discourse](https://community.openstreetmap.org/c/general/38/all).
+
+## Product Roadmap
+We have included below a [high level roadmap/plan](https://github.com/orgs/hotosm/projects/28/) [subject to change] that can be used as an overview.
+
+
+## Developers
+
+* [Understand the code](./docs/developers/understanding-the-code.md)
+* [Setup the TM for development](./docs/developers/development-setup.md)
+* [Learn about versions and releases](./docs/developers/versions-and-releases.md)
+* Help us and submit [pull requests](https://github.com/hotosm/tasking-manager/pulls)
+
+## Instances
+* [HOT Tasking Manager (production)](https://tasks.hotosm.org)
+* [HOT Tasking Manager (staging)](https://tasks-stage.hotosm.org)
+* [TeachOSM](https://tasks.teachosm.org/)
+* [OpenStreetMap Indonesia](https://tasks-indonesia.hotosm.org/)
+* [OpenStreetMap US](https://tasks.openstreetmap.us/)
+* [Map My Kerala](https://mapmykerala.in/)
+* [OpenHistoricalMap](https://tasks.openhistoricalmap.org)
+* [Oceania Tasking Manager](https://tasks.smartcitiestransport.com/)

mkdocs.yml

@@ -0,0 +1,83 @@
+site_name: tasking-manager
+site_description: The HOT Tasking Manager
+# strict: true
+site_url: "https://www.hotosm.org"
+
+repo_name: "hotosm/tasking-manager"
+repo_url: "https://github.com/hotosm/tasking-manager/"
+edit_uri: "edit/main/docs/"
+
+extra:
+  social:
+    - icon: "fontawesome/brands/github"
+      link: "https://github.com/hotosm/"
+    - icon: "fontawesome/brands/twitter"
+      link: "https://twitter.com/hotosm"
+    - icon: "fontawesome/solid/globe"
+      link: "https://www.hotosm.org"
+  copyright: Copyright © 2010 HOTOSM
+  generator: false
+
+theme:
+  name: material
+  palette:
+    primary: custom
+  favicon: images/favicon.png
+  logo: images/hot_logo.png
+  # custom_dir: docs/overrides
+
+extra_css:
+  - css/extra.css
+
+markdown_extensions:
+  - tables
+  - toc:
+      permalink: true
+      title: Page contents
+  - admonition
+  - pymdownx.details
+  - pymdownx.superfences
+  - pymdownx.highlight
+  - pymdownx.extra
+  - pymdownx.emoji:
+  - pymdownx.tabbed:
+      alternate_style: true
+
+plugins:
+#  - mkdocs_protobuf:
+#      proto_dir: */*.proto *.proto
+  - search
+  - exclude:
+      glob:
+        - plugins/*
+        - __pycache__/*
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [.]
+          options:
+            members_order: source
+            separate_signature: true
+            filters: ["!^_"]
+            docstring_options:
+              ignore_init_summary: true
+            merge_init_into_class: true
+
+nav:
+  - Home: index.md
+  - About: about.md
+  - For Developers:
+#       - Understanding the Code: developers/understanding-the-code.md
+      - Contributing Guidelines: developers/contributing-guidelines.md
+      - Development Setup: developers/development-setup.md
+      - Versions and Releases: developers/versions-and-releases.md
+  - For Sysadmins:
+#      - Monitoring and Logging: sysadmins/monitoring-logging.md
+#      - Networking: sysadmins/networking-connectivity.md
+      - Deployment: sysadmins/deployment.md
+      - CI: sysadmins/ci-cd.md
+      - Architecture: sysadmins/architecture.md
+#      - Security and Reliability: sysadmins/security-reliability-processes.md
+  - Class Hierarchy: apidocs/html/index.html
+  - License: LICENSE.md
+#  - Changelog: CHANGELOG.md

pyproject.toml

@@ -64,6 +64,14 @@ lint = "black manage.py backend tests migrations"
 flake8 = "flake8 manage.py backend tests migrations"
 coverage-discover = "coverage run -m unittest discover"
 
+
+[tool.commitizen]
+name = "cz_conventional_commits"
+tag_format = "$version"
+version_scheme = "pep440"
+version_provider = "pep621"
+update_changelog_on_bump = true
+major_version_zero = true
 [build-system]
 requires = ["pdm-pep517>=1.0.0"]
 build-backend = "pdm.pep517.api"