From 1f5d8a36ce871b32aaf4a44102d4e11a67f074cf Mon Sep 17 00:00:00 2001 From: Gerald Kunzmann Date: Fri, 29 Jan 2016 12:15:26 +0100 Subject: Editorials Addressing the doc8 warnings. Fixes also the wrong image file path. Some more bug fixing on indentation. Addressing severe title level inconsistencies. Change-Id: I9ca235205056bf78c8f370055d05b6c6b3b7367d Signed-off-by: Gerald Kunzmann --- docs/devguide/index.rst | 74 +++++++++++++++++++++++++------------------------ 1 file changed, 38 insertions(+), 36 deletions(-) (limited to 'docs/devguide') diff --git a/docs/devguide/index.rst b/docs/devguide/index.rst index e6a294f8a..bdf0e5b26 100644 --- a/docs/devguide/index.rst +++ b/docs/devguide/index.rst @@ -39,6 +39,7 @@ Functest can be described as follow:: Functest deals with internal and external test cases. The Internal test cases in Brahmaputra are: + * vPing * ODL * Tempest @@ -77,41 +78,42 @@ The Functest docker directories are:: |-- releng `-- vims-test - -+--------------+-------------------+---------------------------------------------------------+ -| Directory | Subdirectory | Comments | -+--------------+-------------------+---------------------------------------------------------+ -| | /conf | All the useful configuration file(s) for | -| | | the openstack creds are put there for CI | -| | | It is recommended to push it there when passing the | -| | | credentials to container through the -v option | -| +-------------------+---------------------------------------------------------+ -| opnfv | /data | Usefull data, images for | -| | | By default we put an image cirros-0.3.4-x86_64-disk.img | -| | | This image can be used by any projects | -| +-------------------+---------------------------------------------------------+ -| | /results | Local result directory of project | -+--------------+-------------------+---------------------------------------------------------+ -| | bgpvpn | | -| +-------------------+ + -| repos | doctor | | -| +-------------------+ + -| | functest | | -| +-------------------+ + -| | odl_integration | | -| +-------------------+ Clone of the useful repositories + -| | onos | These repositories may include: | -| +-------------------+ - tooling + -| | promise | - scenario | -| +-------------------+ - scripts + -| | rally | | -| +-------------------+ + -| | releng | | -| +-------------------+ + -| | vims-test | | -| +-------------------+ + -| | | | -+--------------+-------------------+---------------------------------------------------------+ +:: + + +--------------+-------------------+---------------------------------------------------------+ + | Directory | Subdirectory | Comments | + +--------------+-------------------+---------------------------------------------------------+ + | | /conf | All the useful configuration file(s) for | + | | | the openstack creds are put there for CI | + | | | It is recommended to push it there when passing the | + | | | credentials to container through the -v option | + | +-------------------+---------------------------------------------------------+ + | opnfv | /data | Usefull data, images for | + | | | By default we put an image cirros-0.3.4-x86_64-disk.img | + | | | This image can be used by any projects | + | +-------------------+---------------------------------------------------------+ + | | /results | Local result directory of project | + +--------------+-------------------+---------------------------------------------------------+ + | | bgpvpn | | + | +-------------------+ + + | repos | doctor | | + | +-------------------+ + + | | functest | | + | +-------------------+ + + | | odl_integration | | + | +-------------------+ Clone of the useful repositories + + | | onos | These repositories may include: | + | +-------------------+ - tooling + + | | promise | - scenario | + | +-------------------+ - scripts + + | | rally | | + | +-------------------+ + + | | releng | | + | +-------------------+ + + | | vims-test | | + | +-------------------+ + + | | | | + +--------------+-------------------+---------------------------------------------------------+ Before running the test suite, you must prepare the environement by running:: @@ -214,7 +216,7 @@ The current libraries used in Functest container are:: prepare_env.sh -============ +============== This script can be adapted if you need to set up a specific environment before running the tests. -- cgit 1.2.3-korg