Update metadata and docs for new data service #2714

globaldothealth · Jun 17, 2022 · ee395ee · ee395ee
1 parent 3df1f03
commit ee395ee
Show file tree

Hide file tree

Showing 4 changed files with 183 additions and 10 deletions.
diff --git a/data-serving/README.md b/data-serving/README.md
@@ -1,8 +1,21 @@
 # All things data
 
+# Emerging outbreaks
+
+Any new outbreak that is tracked by Global.health will use the `reusable-data-service` for CRUD operations on line list cases.
+It incorporates a simple "day zero" schema along with facilities for flexibly extending the data model.
+
+## Configuration
+
+TBD as the service gets written!
+
+# COVID-19 instances
+
+The `data-service` folder contains the service for CRUD operations involving the COVID-19 schema.
+
 ## Database design
 
-G.h case data, as well as the source, user, and session data for the curator portal, is stored in a MongoDB database.
+G.h COVID-19 case data, as well as the source, user, and session data for the curator portal, is stored in a MongoDB database.
 
 We have multiple instances of MongoDB, ranging from local instances for development, to dev and qa (for
 https://dev-data.covid-19.global.health/ and https://qa-data.covid-19.global.health in the case of COVID-19 data),
@@ -154,9 +167,3 @@ Add your index as a [migration](https://github.com/globaldothealth/list/tree/mai
 ##### Sample PRs
 
 * [Adding a new compound index](https://github.com/globaldothealth/list/pull/701/files)
-
-## Extending to new outbreaks
-
-Our database design is intended to be flexible enough to support future outbreaks. To spin up an instance of the curator
-service with a different dataset, create a new database in your MongoDB instance and
-[point the curator portal to it](https://github.com/globaldothealth/list/blob/main/dev/docker-compose.yml).
diff --git a/data-serving/reusable-data-service/README.rst b/data-serving/reusable-data-service/README.rst
@@ -0,0 +1,11 @@
+#####################
+Reusable Data Service
+#####################
+
+Introduction
+============
+
+The Global.health reusable data service takes lessons learned from the
+COVID-19 data service (see ../data-service) and provides a scalable,
+extensible application server for CRUD operations on line list data
+for infectious disease outbreaks.
diff --git a/data-serving/reusable-data-service/poetry.lock b/data-serving/reusable-data-service/poetry.lock
diff --git a/data-serving/reusable-data-service/pyproject.toml b/data-serving/reusable-data-service/pyproject.toml
@@ -1,11 +1,11 @@
 [tool.poetry]
 name = "reusable-data-service"
 version = "0.1.0"
-description = ""
-authors = ["Graham Lee <graham.lee@cs.ox.ac.uk>"]
+description = "A scalable, extensible application server for CRUD operations on line list data for infectious disease outbreaks."
+authors = ["Global.health <info@global.health>"]
 
 [tool.poetry.dependencies]
-python = "^3.9"
+python = "^3.10"
 
 [tool.poetry.dev-dependencies]
 pytest = "^5.2"