diff options
author | Emma Foley <emma.l.foley@intel.com> | 2018-03-07 18:40:28 +0000 |
---|---|---|
committer | Emma Foley <emma.l.foley@intel.com> | 2018-04-03 08:15:50 +0000 |
commit | 3248682fcc789f95ff8246a8d1f208a6a3abd46d (patch) | |
tree | 09431d10ed8e3bd65be6b2e41e74ff8eb8dfd177 /docs/testing/user/userguide/10-yardstick-user-interface.rst | |
parent | cff53001219021a0dd79f278ca3fdda0f26cf9f4 (diff) |
[docs] Move user guide chapters to make room for new chapter.
* Increment the numbering on chapters
* Fix some of the changes flagged by doc8
Change-Id: Ie03d165297671dfd50b9de339612cdc8bf00b988
Signed-off-by: Emma Foley <emma.l.foley@intel.com>
Diffstat (limited to 'docs/testing/user/userguide/10-yardstick-user-interface.rst')
-rw-r--r-- | docs/testing/user/userguide/10-yardstick-user-interface.rst | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/testing/user/userguide/10-yardstick-user-interface.rst b/docs/testing/user/userguide/10-yardstick-user-interface.rst new file mode 100644 index 000000000..cadec78ef --- /dev/null +++ b/docs/testing/user/userguide/10-yardstick-user-interface.rst @@ -0,0 +1,30 @@ +======================== +Yardstick User Interface +======================== + +This interface provides a user to view the test result +in table format and also values pinned on to a graph. + + +Command +======= +:: + + yardstick report generate <task-ID> <testcase-filename> + + +Description +=========== + +1. When the command is triggered using the task-id and the testcase +name provided the respective values are retrieved from the +database (influxdb in this particular case). + +2. The values are then formatted and then provided to the html +template framed with complete html body using Django Framework. + +3. Then the whole template is written into a html file. + +The graph is framed with Timestamp on x-axis and output values +(differ from testcase to testcase) on y-axis with the help of +"Highcharts". |