Update documentation diagram with otn xponder 94/89694/1
authorGilles Thouenon <gilles.thouenon@orange.com>
Thu, 5 Mar 2020 17:47:17 +0000 (18:47 +0100)
committerguillaume.lambert <guillaume.lambert@orange.com>
Tue, 12 May 2020 08:24:40 +0000 (10:24 +0200)
and improve the inventory documentation.

Signed-off-by: Gilles Thouenon <gilles.thouenon@orange.com>
Change-Id: I7932a107e2b8a5da77f48ee7dcce20d8be5ae417

docs/developer-guide.rst
docs/images/TransportPCE-Diagramm-Magnesium.jpg
docs/user-guide.rst

index 0373550b6c3719bfd6719c8d341fb11de9b5202a..bc0927920cf4d0fea562e2083a006ca0ea803b4a 100644 (file)
@@ -209,7 +209,7 @@ The database properties are supplied in the “opendaylight-release” and “op
 Below is the settings.xml with properties included in the distribution.
 The module can be rebuild from sources with different parameters.
 
-Sample entry in settings.xml to include inventory:
+Sample entry in settings.xml to declare an external inventory database:
 ::
 
     <profiles>
@@ -239,10 +239,10 @@ Sample entry in settings.xml to include inventory:
     </profiles>
 
 
-Once the project built and when karaf is started, the cfg file is generated in etc folder with the corresponding properties
-supplied in settings.xml. When devices with OpenROADM 1.2.1 device model are mounted, the device listener in the inventory
-module loads several device attributes to various tables as per the supplied database.
-The databsase structure details can be retrieved from the file tests/inventory/initdb.sql in project sources.
+Once the project built and when karaf is started, the cfg file is generated in etc folder with the corresponding
+properties supplied in settings.xml. When devices with OpenROADM 1.2.1 device model are mounted, the device listener in
+the inventory module loads several device attributes to various tables as per the supplied database.
+The database structure details can be retrieved from the file tests/inventory/initdb.sql inside project sources.
 Installation scripts and a docker file are also provided.
 
 Key APIs and Interfaces
index 388a9a3d71c9d6bf20ed131650720784d390b756..dce308b295fe838fcfbe17290419543c5cabef87 100644 (file)
Binary files a/docs/images/TransportPCE-Diagramm-Magnesium.jpg and b/docs/images/TransportPCE-Diagramm-Magnesium.jpg differ
index 9f3966d41e9cfea051c4a472ebfe9191622d5fc3..6cb4eac7eaf5512791ac6b0cc4f36bc429a45180 100644 (file)
@@ -52,8 +52,8 @@ TransportPCE User-Facing Features
 
 -  **feature odl-transportpce-inventory**
 
-   -  This feature is considered experimental.
-      It provides transportPCE an external connector to a MariaDB inventory currently limited to OpenROADM 1.2.1 devices.
+   -  This feature is considered experimental. It provides transportPCE with an external connector to
+      a MariaDB inventory currently limited to OpenROADM 1.2.1 devices.
 
 How To Start
 ------------