Skip to content

Commit

Permalink
docs: add user/dev roadmaps, timeline, update readme badges
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Apr 18, 2024
1 parent e0cc117 commit 8591c7d
Show file tree
Hide file tree
Showing 8 changed files with 101 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) |

<!-- markdownlint-restore -->

Expand Down
1 change: 1 addition & 0 deletions docs/images/dev_roadmap_badge.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 0 additions & 1 deletion docs/images/roadmap_badge.svg

This file was deleted.

1 change: 1 addition & 0 deletions docs/images/timeline_badge.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/images/user_roadmap_badge.svg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
80 changes: 80 additions & 0 deletions docs/timeline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Timeline

<!-- markdownlint-disable -->

> <div style="border-left: 4px solid gray; border-radius: 0 4px 4px 0; background: rgba(200, 200, 200, 0.15); margin: 2rem auto; padding: 1rem 2rem; position: relative; text-align: center; margin-left: 7rem;">
>
> <div style="text-align: left; position: relative; padding-bottom: 1rem; margin-bottom: 1rem;">
> <div style="position: absolute; left: -10rem; text-align: right; font-size: 0.9rem; font-weight: 700; opacity: 0.7; min-width: 6rem; top: 2px;">2022-10</div>
>
> <h3>Project Start</h3>
> The first commit was made to the Github project.
>
> <div style="position: absolute; box-shadow: 0 0 0 4px gray; left: -2.5rem; background: #444; border-radius: 50%; height: 11px; width: 11px; top: 5px;"></div>
> </div>
>
> <div style="text-align: left; position: relative; padding-bottom: 1rem; margin-bottom: 1rem;">
> <div style="position: absolute; left: -10rem; text-align: right; font-size: 0.9rem; font-weight: 700; opacity: 0.7; min-width: 6rem; top: 2px;">2023-02</div>
>
> <h3>Demo: Response to Turkey/Syria Earthquake</h3>
> A call was made for open-source software developers to assist rapid development.
>
> <div style="position: absolute; box-shadow: 0 0 0 4px gray; left: -2.5rem; background: #444; border-radius: 50%; height: 11px; width: 11px; top: 5px;"></div>
> </div>
>
> <div style="text-align: left; position: relative; padding-bottom: 1rem; margin-bottom: 1rem;">
> <div style="position: absolute; left: -10rem; text-align: right; font-size: 0.9rem; font-weight: 700; opacity: 0.7; min-width: 6rem; top: 2px;">2023-03</div>
>
> <h3>NAXA Awarded Contract to Assist FMTM Development</h3>
> HOT's main collaborator on FMTM, NAXA, was contracted to continue development.
>
> <div style="position: absolute; box-shadow: 0 0 0 4px gray; left: -2.5rem; background: #444; border-radius: 50%; height: 11px; width: 11px; top: 5px;"></div>
> </div>
>
> <div style="text-align: left; position: relative; padding-bottom: 1rem; margin-bottom: 1rem;">
> <div style="position: absolute; left: -10rem; text-align: right; font-size: 0.9rem; font-weight: 700; opacity: 0.7; min-width: 6rem; top: 2px;">2023-08</div>
>
> <h3>Demo: Rwanda Road Assessment</h3>
> Rwanda building and road assessment after severe flooding.
>
> <div style="position: absolute; box-shadow: 0 0 0 4px gray; left: -2.5rem; background: #444; border-radius: 50%; height: 11px; width: 11px; top: 5px;"></div>
> </div>
>
> <div style="text-align: left; position: relative; padding-bottom: 1rem; margin-bottom: 1rem;">
> <div style="position: absolute; left: -10rem; text-align: right; font-size: 0.9rem; font-weight: 700; opacity: 0.7; min-width: 6rem; top: 2px;">2023-08</div>
>
> <h3>Rapid Development & Iteration of FMTM</h3>
> Growth phase of FMTM with large improvements to the FMTM workflow & usability.
>
> <div style="position: absolute; box-shadow: 0 0 0 4px gray; left: -2.5rem; background: #444; border-radius: 50%; height: 11px; width: 11px; top: 5px;"></div>
> </div>
>
> <div style="text-align: left; position: relative; padding-bottom: 1rem; margin-bottom: 1rem;">
> <div style="position: absolute; left: -10rem; text-align: right; font-size: 0.9rem; font-weight: 700; opacity: 0.7; min-width: 6rem; top: 2px;">2024-02</div>
>
> <h3>Demo: Monrovia, Liberia</h3>
> The first conceptualisation of HOT's full E2E workflow, after field mapping feedback.
>
> <div style="position: absolute; box-shadow: 0 0 0 4px gray; left: -2.5rem; background: #444; border-radius: 50%; height: 11px; width: 11px; top: 5px;"></div>
> </div>
>
> <div style="text-align: left; position: relative; padding-bottom: 1rem; margin-bottom: 1rem;">
> <div style="position: absolute; left: -10rem; text-align: right; font-size: 0.9rem; font-weight: 700; opacity: 0.7; min-width: 6rem; top: 2px;">2024-03</div>
>
> <h3>Demo: Karangasem, Bali</h3>
> Landslide risk assessment, refinement of the E2E workflow.
>
> <div style="position: absolute; box-shadow: 0 0 0 4px gray; left: -2.5rem; background: #444; border-radius: 50%; height: 11px; width: 11px; top: 5px;"></div>
> </div>
>
> <div style="text-align: left; position: relative; padding-bottom: 1rem; margin-bottom: 1rem;">
> <div style="position: absolute; left: -10rem; text-align: right; font-size: 0.9rem; font-weight: 700; opacity: 0.7; min-width: 6rem; top: 2px;">2024-04</div>
>
> <h3>Demo: CLIGEOS, Nepal</h3>
> Demo of FMTM within a full E2E workshop.
>
> <div style="position: absolute; box-shadow: 0 0 0 4px gray; left: -2.5rem; background: #444; border-radius: 50%; height: 11px; width: 11px; top: 5px;"></div>
> </div>
> </div>
<!-- markdownlint-restore -->
13 changes: 13 additions & 0 deletions docs/user-roadmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# User Roadmap

<!-- markdownlint-disable -->

| 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) | |

<!-- markdownlint-restore -->
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 8591c7d

Please sign in to comment.