[userguide] Update the directory structure listing 13/64913/1
authorEmma Foley <emma.l.foley@intel.com>
Tue, 28 Aug 2018 13:34:55 +0000 (14:34 +0100)
committerRex Lee <limingjiang@huawei.com>
Fri, 9 Nov 2018 18:06:53 +0000 (18:06 +0000)
Change-Id: I4ff6f94a6d309e1604672a41c581d0768c91a5d2
JIRA: YARDSTICK-1335
Signed-off-by: Emma Foley <emma.l.foley@intel.com>
(cherry picked from commit b7c2a088b375bb6895c52383c4348b1cb1d4edb9)

docs/testing/user/userguide/03-architecture.rst

index 8866315..62250d6 100755 (executable)
@@ -243,26 +243,27 @@ Yardstick Directory structure
         with support for different installers.
 
 *docs/* - All documentation is stored here, such as configuration guides,
-          user guides and Yardstick descriptions.
+          user guides and Yardstick test case descriptions.
 
 *etc/* - Used for test cases requiring specific POD configurations.
 
 *samples/* - test case samples are stored here, most of all scenario and
-             feature's samples are shown in this directory.
+             feature samples are shown in this directory.
 
-*tests/* - Here both Yardstick internal tests (*functional/* and *unit/*) as
-           well as the test cases run to verify the NFVI (*opnfv/*) are stored.
-           Also configurations of what to run daily and weekly at the different
-           PODs is located here.
+*tests/* - The test cases run to verify the NFVI (*opnfv/*) are stored here.
+           The configurations of what to run daily and weekly at the different
+           PODs are also located here.
 
-*tools/* - Currently contains tools to build image for VMs which are deployed
-           by Heat. Currently contains how to build the yardstick-trusty-server
-           image with the different tools that are needed from within the
-           image.
+*tools/* - Contains tools to build image for VMs which are deployed by Heat.
+           Currently contains how to build the yardstick-image with the
+           different tools that are needed from within the image.
 
 *plugin/* - Plug-in configuration files are stored here.
 
-*yardstick/* - Contains the internals of Yardstick: Runners, Scenario, Contexts,
-               CLI parsing, keys, plotting tools, dispatcher, plugin
+*yardstick/* - Contains the internals of Yardstick: :term:`Runners <runner>`,
+               :term:`Scenarios <scenario>`, :term:`Contexts <context>`, CLI
+               parsing, keys, plotting tools, dispatcher, plugin
                install/remove scripts and so on.
 
+*yardstick/tests* - The Yardstick internal tests (*functional/* and *unit/*)
+                    are stored here.