From 74f4bc602dc96c45e3300a7d256ea81c7ae47c01 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Tue, 12 Dec 2023 11:37:23 +0000 Subject: [PATCH] refactor: rename module pages --- docs/modules.md | 8 +++--- .../{modules-backend.md => backend.md} | 27 ++++++++++--------- .../{modules-frontend.md => frontend.md} | 0 3 files changed, 19 insertions(+), 16 deletions(-) rename docs/modules/{modules-backend.md => backend.md} (97%) rename docs/modules/{modules-frontend.md => frontend.md} (100%) diff --git a/docs/modules.md b/docs/modules.md index b441b92..0fa4c66 100644 --- a/docs/modules.md +++ b/docs/modules.md @@ -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, @@ -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. diff --git a/docs/modules/modules-backend.md b/docs/modules/backend.md similarity index 97% rename from docs/modules/modules-backend.md rename to docs/modules/backend.md index 68f5dc5..cae132b 100644 --- a/docs/modules/modules-backend.md +++ b/docs/modules/backend.md @@ -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) @@ -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 @@ -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, @@ -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 @@ -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, @@ -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() diff --git a/docs/modules/modules-frontend.md b/docs/modules/frontend.md similarity index 100% rename from docs/modules/modules-frontend.md rename to docs/modules/frontend.md