Start expanding the docs on initiatives
Signed-off-by: Pierre-Yves Chibon <pingou@pingoured.fr>
This commit is contained in:
parent
0e7276571e
commit
4248f10bc8
4 changed files with 49 additions and 0 deletions
25
docs/datanommer_datagrepper/datanommer.rst
Normal file
25
docs/datanommer_datagrepper/datanommer.rst
Normal file
|
@ -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
|
16
docs/datanommer_datagrepper/index.rst
Normal file
16
docs/datanommer_datagrepper/index.rst
Normal file
|
@ -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
|
|
@ -19,6 +19,7 @@ Contents:
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
workflow
|
workflow
|
||||||
|
initiatives
|
||||||
arc_names
|
arc_names
|
||||||
|
|
||||||
|
|
||||||
|
|
7
docs/initiatives.rst
Normal file
7
docs/initiatives.rst
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
Initiatives
|
||||||
|
===========
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 2
|
||||||
|
|
||||||
|
datanommer_datagrepper/index
|
Loading…
Add table
Add a link
Reference in a new issue