From 4248f10bc80177e0a165dc023a86677b3e6e7978 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Chibon Date: Mon, 18 Jan 2021 15:41:29 +0100 Subject: [PATCH] Start expanding the docs on initiatives Signed-off-by: Pierre-Yves Chibon --- docs/datanommer_datagrepper/datanommer.rst | 25 ++++++++++++++++++++++ docs/datanommer_datagrepper/index.rst | 16 ++++++++++++++ docs/index.rst | 1 + docs/initiatives.rst | 7 ++++++ 4 files changed, 49 insertions(+) create mode 100644 docs/datanommer_datagrepper/datanommer.rst create mode 100644 docs/datanommer_datagrepper/index.rst create mode 100644 docs/initiatives.rst diff --git a/docs/datanommer_datagrepper/datanommer.rst b/docs/datanommer_datagrepper/datanommer.rst new file mode 100644 index 0000000..bcd0fa7 --- /dev/null +++ b/docs/datanommer_datagrepper/datanommer.rst @@ -0,0 +1,25 @@ +.. _datanommer: + +Datanommer +========== + +* Reads-in messages from the bus +* Stores them into the database + +Database tables +--------------- + +Here is how the database schema looks like currently: + +:: + + datanommer=# \dt + List of relations + Schema | Name | Type | Owner + --------+------------------+-------+------------ + public | alembic_version | table | datanommer + public | messages | table | datanommer + public | package | table | datanommer + public | package_messages | table | datanommer + public | user | table | datanommer + public | user_messages | table | datanommer diff --git a/docs/datanommer_datagrepper/index.rst b/docs/datanommer_datagrepper/index.rst new file mode 100644 index 0000000..ddb10ae --- /dev/null +++ b/docs/datanommer_datagrepper/index.rst @@ -0,0 +1,16 @@ +Datanommer / Datagrepper +======================== + +Datanommer +---------- + +* Reads-in messages from the bus +* Stores them into the database + +:ref:`datanommer` + +Datagrepper +----------- + +* Exposes the messages in the database via an API with different filtering + capacity diff --git a/docs/index.rst b/docs/index.rst index c0d5fef..8927f72 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -19,6 +19,7 @@ Contents: :maxdepth: 2 workflow + initiatives arc_names diff --git a/docs/initiatives.rst b/docs/initiatives.rst new file mode 100644 index 0000000..87dd0b5 --- /dev/null +++ b/docs/initiatives.rst @@ -0,0 +1,7 @@ +Initiatives +=========== + +.. toctree:: + :maxdepth: 2 + + datanommer_datagrepper/index