Spec for comparison view

JIRA: QTIP-128
Change-Id: Iade0b139416973dc228878b7ff42596d5d5a66fa
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>

diff --git a/docs/designspec/dashboard.rst b/docs/designspec/dashboard.rst
index ad5520b..20a407a 100644 (file)
--- a/docs/designspec/dashboard.rst
+++ b/docs/designspec/dashboard.rst
@@ -68,3 +68,47 @@ Comparison
 
 Comparison can be done between different PODs or different configuration on the
 same PODs.
+
+In a comparison view, the metrics are displayed in the same diagram. And the
+parameters are listed side by side.
+
+Both common parameters and different parameters are listed. Common values are
+merged to the same cell. And user may configure the view to hide common rows.
+
+A draft design is as following::
+
+    ^
+    |
+    |
+    |
+    |           XXXXXXXX
+    |         XXX      XX+-+ XXXXXXXXXX
+    |      XXX          +XXXX         XXXXX
+    +-+XX X         +--+    ++            XXXXXX     +-+
+    | X+-+X   +----+          +-+              +----+X
+    |X    +--+                   +---+         XXXXXX X
+    |                                 +-------+        X
+    |
+    |
+    +----------------------------------------------------->
+
+    +--------------------+----------------+---------------+
+    | different param 1  |                |               |
+    |                    |                |               |
+    +-----------------------------------------------------+
+    | different param 2  |                |               |
+    |                    |                |               |
+    +-------------------------------------+---------------+
+    | common param 1     |                                |
+    |                    |                                |
+    +-------------------------------------+---------------+
+    | different param 3  |                |               |
+    |                    |                |               |
+    +-------------------------------------+---------------+
+    | common param 2     |                                |
+    |                    |                                |
+    +--------------------+--------------------------------+
+                                             +------------+
+                                             | HIDE COMMON|
+                                             +------------+
+