Update user guide

Change-Id: Ie88251ec761a2992e25830652b7ecad1a21cb376
Signed-off-by: Ulas Kozat <ulas.kozat@gmail.com>

diff --git a/docs/userguide/api-documentation.rst b/docs/userguide/api-documentation.rst
index df922da..c40894c 100644 (file)
--- a/docs/userguide/api-documentation.rst
+++ b/docs/userguide/api-documentation.rst
@@ -1,5 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
+
 .. image:: ../etc/opnfv-logo.png 
   :height: 40
   :width: 200
@@ -9,11 +10,26 @@
 |
 |
 Using domino-cli Client
-==========================
+=======================
+
+* heartbeat message
+
+Message fields:
+
+.. code-block:: bash
+  struct HeartBeatMessage {
+   1: MessageType messageType = HEART_BEAT,
+   2: i64 domino_udid,
+   3: i64 seq_no  
+  }
+
+.. code-block:: bash
+
+  ./domino-cli.py heartbeat
 
 
-Using interactive CLI mode
-==========================
+Interactive CLI mode
+====================
 
 
 

diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst
index 5f87ae5..aaa8f97 100644 (file)
--- a/docs/userguide/index.rst
+++ b/docs/userguide/index.rst
@@ -7,8 +7,8 @@
   :alt: OPNFV
   :align: left
 
-Example Documentation table of contents
-=======================================
+DOMINO API DOCUMENTATION
+========================
 
 Contents: