From 8591c7da97f5ab9de7c290febd6d83a636e26768 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Thu, 18 Apr 2024 11:31:31 +0100 Subject: [PATCH] docs: add user/dev roadmaps, timeline, update readme badges --- README.md | 2 +- docs/images/dev_roadmap_badge.svg | 1 + docs/images/roadmap_badge.svg | 1 - docs/images/timeline_badge.svg | 1 + docs/images/user_roadmap_badge.svg | 1 + docs/timeline.md | 80 ++++++++++++++++++++++++++++++ docs/user-roadmap.md | 13 +++++ mkdocs.yml | 5 +- 8 files changed, 101 insertions(+), 3 deletions(-) create mode 100644 docs/images/dev_roadmap_badge.svg delete mode 100644 docs/images/roadmap_badge.svg create mode 100644 docs/images/timeline_badge.svg create mode 100644 docs/images/user_roadmap_badge.svg create mode 100644 docs/timeline.md create mode 100644 docs/user-roadmap.md diff --git a/README.md b/README.md index 3741dff5e6..31df26d76d 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Coordinated field mapping for Open Mapping campaigns. | **Tech Stack** | ![FastAPI](https://img.shields.io/badge/FastAPI-005571?style=for-the-badge&logo=fastapi) ![React](https://img.shields.io/badge/react-%2320232a.svg?style=for-the-badge&logo=react&logoColor=%2361DAFB) ![Postgres](https://img.shields.io/badge/postgres-%23316192.svg?style=for-the-badge&logo=postgresql&logoColor=white) ![Kubernetes](https://img.shields.io/badge/kubernetes-%23326ce5.svg?style=for-the-badge&logo=kubernetes&logoColor=white) ![Docker](https://img.shields.io/badge/docker-%230db7ed.svg?style=for-the-badge&logo=docker&logoColor=white) | | **Code Style** | ![Backend Style](https://img.shields.io/badge/code%20style-black-black) ![Frontend Style](https://img.shields.io/badge/code%20style-prettier-F7B93E?logo=Prettier) ![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white) | | **Metrics** | [![All Contributors](https://img.shields.io/github/all-contributors/hotosm/fmtm?color=ee8449&style=flat-square)](#contributors-) [![Coverage](https://hotosm.github.io/fmtm/coverage.svg)](https://hotosm.github.io/fmtm/coverage.html) | -| **Other Info** | [![Docs](https://github.com/hotosm/fmtm/blob/development/docs/images/docs_badge.svg?raw=true)](https://hotosm.github.io/fmtm/) [![Roadmap](https://github.com/hotosm/fmtm/blob/development/docs/images/roadmap_badge.svg?raw=true)](https://github.com/orgs/hotosm/projects/22/views/1?sliceBy[columnId]=Milestone) [![GitHub Sponsors](https://img.shields.io/badge/sponsor-30363D?logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/hotosm) [![License](https://img.shields.io/github/license/hotosm/fmtm.svg)](https://github.com/hotosm/fmtm/blob/main/LICENSE.md) | +| **Other Info** | [![docs](https://github.com/hotosm/fmtm/blob/development/docs/images/docs_badge.svg?raw=true)](https://hotosm.github.io/fmtm/) [![user-roadmap](https://github.com/hotosm/fmtm/blob/development/docs/images/user_roadmap_badge.svg?raw=true)](https://fmtm.dev/user-roadmap) [![dev-roadmap](https://github.com/hotosm/fmtm/blob/development/docs/images/dev_roadmap_badge.svg?raw=true)](https://roadmap.fmtm.dev) [![timeline](https://github.com/hotosm/fmtm/blob/development/docs/images/timeline_badge.svg?raw=true)](https://fmtm.dev/timeline) [![license](https://img.shields.io/github/license/hotosm/fmtm.svg)](https://github.com/hotosm/fmtm/blob/main/LICENSE.md) | diff --git a/docs/images/dev_roadmap_badge.svg b/docs/images/dev_roadmap_badge.svg new file mode 100644 index 0000000000..250560202e --- /dev/null +++ b/docs/images/dev_roadmap_badge.svg @@ -0,0 +1 @@ +🎯 Dev Roadmap🎯 Dev Roadmap \ No newline at end of file diff --git a/docs/images/roadmap_badge.svg b/docs/images/roadmap_badge.svg deleted file mode 100644 index 623516fb9b..0000000000 --- a/docs/images/roadmap_badge.svg +++ /dev/null @@ -1 +0,0 @@ -🎯 Roadmap🎯 Roadmap \ No newline at end of file diff --git a/docs/images/timeline_badge.svg b/docs/images/timeline_badge.svg new file mode 100644 index 0000000000..3acfd8bd25 --- /dev/null +++ b/docs/images/timeline_badge.svg @@ -0,0 +1 @@ +πŸ“… TimelineπŸ“… Timeline \ No newline at end of file diff --git a/docs/images/user_roadmap_badge.svg b/docs/images/user_roadmap_badge.svg new file mode 100644 index 0000000000..baa306bf0c --- /dev/null +++ b/docs/images/user_roadmap_badge.svg @@ -0,0 +1 @@ +🎯 User Roadmap🎯 User Roadmap \ No newline at end of file diff --git a/docs/timeline.md b/docs/timeline.md new file mode 100644 index 0000000000..36708af5ac --- /dev/null +++ b/docs/timeline.md @@ -0,0 +1,80 @@ +# Timeline + + + +>
+> +>
+>
2022-10
+> +>

Project Start

+> The first commit was made to the Github project. +> +>
+>
+> +>
+>
2023-02
+> +>

Demo: Response to Turkey/Syria Earthquake

+> A call was made for open-source software developers to assist rapid development. +> +>
+>
+> +>
+>
2023-03
+> +>

NAXA Awarded Contract to Assist FMTM Development

+> HOT's main collaborator on FMTM, NAXA, was contracted to continue development. +> +>
+>
+> +>
+>
2023-08
+> +>

Demo: Rwanda Road Assessment

+> Rwanda building and road assessment after severe flooding. +> +>
+>
+> +>
+>
2023-08
+> +>

Rapid Development & Iteration of FMTM

+> Growth phase of FMTM with large improvements to the FMTM workflow & usability. +> +>
+>
+> +>
+>
2024-02
+> +>

Demo: Monrovia, Liberia

+> The first conceptualisation of HOT's full E2E workflow, after field mapping feedback. +> +>
+>
+> +>
+>
2024-03
+> +>

Demo: Karangasem, Bali

+> Landslide risk assessment, refinement of the E2E workflow. +> +>
+>
+> +>
+>
2024-04
+> +>

Demo: CLIGEOS, Nepal

+> Demo of FMTM within a full E2E workshop. +> +>
+>
+>
+ + diff --git a/docs/user-roadmap.md b/docs/user-roadmap.md new file mode 100644 index 0000000000..c6d5dcbf52 --- /dev/null +++ b/docs/user-roadmap.md @@ -0,0 +1,13 @@ +# User Roadmap + + + +| In Progress | Next | Future | +| ----------------------------------------------------------------- | ------------------------------------------------------------------ | -------------------------------------------------------- | +| πŸ“΄ Improved workflow for mapping offline, with basemaps and data | πŸ—ΊοΈ Improved workflow for downloading offline base imagery per task | πŸ“» FMTM portable deployment via small field-based device | +| 🟒 Colour buildings when mapping is in progress or complete | πŸ“Š Improve data export format | πŸ“± Further collaboration with ODK developers on Collect | +| πŸ”— Open ODK Collect directly from FMTM, with feature pre-selected | πŸͺ“ Refinements to the task splitting algorithm | 🌍 Direct export (+merge) to OpenStreetMap | +| 🎨 Improving the user interface specifically for mapping | πŸ“– User documentation and tutortials | | +| | πŸ”’ Implementing additional user roles (validator, field admin) | | + + diff --git a/mkdocs.yml b/mkdocs.yml index 3987d3c480..0a18108f49 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -92,4 +92,7 @@ nav: - Versioning: https://docs.hotosm.org/dev-guide/version-control/#creating-releases - Class Hierarchy: apidocs/html/inherits.html - Code Coverage: coverage.html - - Roadmap: https://roadmap.fmtm.dev + - Roadmap: + - Users: user-roadmap.md + - Developers: https://roadmap.fmtm.dev + - Timeline: timeline.md