Skip to content

Commit

Permalink
refactor: rename module pages
Browse files Browse the repository at this point in the history
  • Loading branch information
spwoodcock committed Dec 12, 2023
1 parent cc6bda1 commit 74f4bc6
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 16 deletions.
8 changes: 4 additions & 4 deletions docs/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ frontend functionality. To reduce long-term maintainance and code
duplication, it's better to have the shared functionality in
standalone modules. The other advantage of small sharable modules is
it's much easy to enhance or debug when not buried in much larger
prohects.
prohects.

## Backend

Backend Python modules are released on
[PyPi](https://pypi.org) to be installed across multiple services.

See the [backend](modules/modules-backend.md) page for more info.
See the [backend](modules/backend.md) page for more info.

## Frontend

As a form of standardisation, we use [React](https://react.dev/) as
As a form of standardization, we use [React](https://react.dev/) as
our frontend framework.

Many services have common UI components that can be shared (headers,
Expand All @@ -27,4 +27,4 @@ We also use frontend map libraries extensively (obviously).
Currently we favour [OpenLayers](https://openlayers.org/) due to it's
breadth of functionality.

See the [frontend](modules/modules-frontend.md) page for more info.
See the [frontend](modules/frontend.md) page for more info.
27 changes: 15 additions & 12 deletions docs/modules/modules-backend.md → docs/modules/backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ Postgres database. There is more detail on these modules on the [project
website](https://hotosm.github.io/osm-rawdata)).

### [PostgresClient()](https://hotosm.github.io/osm-rawdata/api/#postgrespy)

This program extracts data from a local postgres data, or the remote
Underpass one. A boundary polygon is used to define the area to be
covered in the extract.
covered in the extract.

### [MapImporter()](https://hotosm.github.io/osm-rawdata/api/#importerpy)

Expand All @@ -35,7 +35,8 @@ Parses Overture Parquet files and creates a data structure of the
data so it can be imported into postgres, or generate an output
GeoJson file.

***
---

## [OSM Fieldwork](https://hotosm.github.io/osm-fieldwork)

Various utility programs useful for field data collection using ODK
Expand Down Expand Up @@ -78,7 +79,8 @@ This supports working with the REST API for ODK Central.

Produces OSM XML out files.

***
---

## [FMTMSplitter](https://hotosm.github.io/fmtm-splitter)

A splitting algorithm using PostGIS to divide an idea into task areas,
Expand All @@ -90,7 +92,8 @@ The division is configurable via various parameters.

Various machine learning utils used within the fAIr backend.

***
---

## [Conflator](https://github.com/hotosm/conflator)

This is a project for conflating external data sets with OpenStreetMap
Expand All @@ -108,13 +111,13 @@ building footprints.

Conflate POIs from external datasets like ODK Collect.

***
---

## [TM Admin](https://github.com/hotosm/tm-admin)

This is a project for profile management of Tasking Manager style
projects.


### [TmAdminManage](https://github.com/hotosm/tm-admin/blob/main/tm_admin/tmadmin-manage.py)

This class and utility program handles creating the data type files,
Expand All @@ -141,8 +144,8 @@ These wrapper classes are generated from the YAML config file, and
contain all the columns from the database table as a Python
class. This is used to create, update, and query the database tables.

* UsersDB()
* TeamsDB()
* ProjectsDB()
* TasksDB()
* OrganizationsDB()
- UsersDB()
- TeamsDB()
- ProjectsDB()
- TasksDB()
- OrganizationsDB()
File renamed without changes.

0 comments on commit 74f4bc6

Please sign in to comment.