Documentation updates

[nonrtric/plt/ranpm.git] / influxlogger / docs / overview.rst

diff --git a/influxlogger/docs/overview.rst b/influxlogger/docs/overview.rst
index 3e975ec..679d0c1 100644 (file)
--- a/influxlogger/docs/overview.rst
+++ b/influxlogger/docs/overview.rst
@@ -11,7 +11,7 @@ Introduction
 ************
 
 The task of the Influx Logger is to receive PM Measurement reports from a Kafka topic and to
-store the mesurement in an Influx time serier database.
+store the measurements in an Influx time series database.
 
 
 .. image:: ./Architecture.png
@@ -38,25 +38,12 @@ Here follows an example of one Influx table which contains aggregated values for
    :width: 1000pt
 
 
-*****************************************
-Setting up the PM mesurement subscription
-*****************************************
-
-The influx logger will create its data subscription automatically. This is done by reading a file that
-defines the data to log and which Kafka topic to use (1). The contents of this file is used to create
-the information job for subscribing of PM measurement (2). ICS will make sure that all PM Measurement producers
-are ordered to start producing data (3).
-
-.. image:: ./Subscription.png
-   :width: 1000pt
-
-An example jobDefinition.json file: ":download:`link <../config/jobDefinition.json>`"
 
 ********************
 Input PM Measurement
 ********************
 
-The PM measuremenet information received from the Kafka topic is produced by the pmproducer.
+The PM measurement information received from the Kafka topic is produced by the pm-producer.
 Here follows an example of the expected input object:
 
 .. code-block:: javascript
@@ -134,9 +121,28 @@ Here follows an example of the expected input object:
 Configuration
 *************
 
-The DFC is configured via its application.yaml
 
 
+==========================================
+Setting up the PM measurement subscription
+==========================================
+
+The influx logger will create its data subscription automatically. This is done by reading a configuration file that
+defines the data to log and which Kafka topic to use (1). The contents of this file is used to create
+the information job for subscribing of PM measurement (2). ICS will make sure that all PM Measurement producers
+are ordered to start producing data (3).
+
+.. image:: ./Subscription.png
+   :width: 1000pt
+
+An example jobDefinition.json file: ":download:`link <../config/jobDefinition.json>`"
+
+================
+application.yaml
+================
+
+The component is configured via its application.yaml
+
 An example application.yaml configuration file: ":download:`link <../config/application.yaml>`"