CSIT-744 Update report content for proper parsing

Follow the good practices for formatting. Update the content of release
report RST files to use the proper directives like :cite:, :footnote:,
:abbr:, :captions: etc.With these markings we will be able to format
output in proper way and style it in various sphinx output builders.

Change-Id: Ibbb538d43c3bd364a6acdcc990097a477f49de00
Signed-off-by: Peter Mikus <pmikus@cisco.com>

2 files changed, 23 insertions, 27 deletions

diff --git a/docs/report/vpp_functional_tests/overview.rst b/docs/report/vpp_functional_tests/overview.rst
index e8f8460d34..fda35072ef 100644
--- a/docs/report/vpp_functional_tests/overview.rst
+++ b/docs/report/vpp_functional_tests/overview.rst
@@ -5,14 +5,12 @@ Tested Virtual Topologies
 -------------------------

 

 CSIT VPP functional tests are executed on virtualized topologies created using

-Virtual Internet Routing Lab (VIRL) simulation platform contributed by Cisco.

-VIRL runs on physical baremetal servers hosted by LF FD.io project.  Majority

-of the tests are executed in the three node logical test topology - Traffic

-Generator (TG) node and two Systems Under Test (SUT) nodes connected in a

-loop. Some tests use two node logical test topology - TG node and SUT1 node.

-Both logical test topologies are shown in the figures below.

-

-::

+:abbr:`VIRL (Virtual Internet Routing Lab)` simulation platform contributed by

+Cisco. VIRL runs on physical baremetal servers hosted by LF FD.io project.

+Majority of the tests are executed in the three node logical test topology -

+Traffic Generator (TG) node and two Systems Under Test (SUT) nodes connected in

+a loop. Some tests use two node logical test topology - TG node and SUT1 node.

+Both logical test topologies are shown in the figures below.::

 

     +------------------------+           +------------------------+

     |                        |           |                        |

@@ -68,9 +66,7 @@ For the test cases that require DUT (VPP) to communicate with VM over the
 vhost-user interfaces, a nested VM is created on SUT1 and/or SUT2 for the

 duration of these particular test cases only. DUT (VPP) test topology with VM

 is shown in the figure below including the applicable packet flow thru the VM

-(marked in the figure with ``***``).

-

-::

+(marked in the figure with ``***``).::

 

     +------------------------+           +------------------------+

     |      +----------+      |           |      +----------+      |

@@ -135,7 +131,7 @@ CSIT |release| follows a common structured naming convention for all
 performance and system functional tests, introduced in CSIT |release-1|.

 

 The naming should be intuitive for majority of the tests. Complete

-description of CSIT test naming convention is provided on 

+description of CSIT test naming convention is provided on

 `CSIT test naming wiki page <https://wiki.fd.io/view/CSIT/csit-test-naming>`_.

 

 Here few illustrative examples of the new naming usage for functional test

diff --git a/docs/report/vpp_functional_tests/test_environment.rst b/docs/report/vpp_functional_tests/test_environment.rst
index 15c27ec708..a4209ed7ae 100644
--- a/docs/report/vpp_functional_tests/test_environment.rst
+++ b/docs/report/vpp_functional_tests/test_environment.rst
@@ -30,14 +30,14 @@ VIRL testbed infrastructure consists of three VIRL hosts:
 Whenever a patch is submitted to gerrit for review, parallel VIRL simulations

 are started to reduce the time of execution of all functional tests. The number

 of parallel VIRL simulations is equal to number of test groups defined by

-TEST_GROUPS variable in csit/bootstrap.sh file. The VIRL host to run VIRL

-simulation is selected based on least load algorithm per VIRL simulation.

+TEST_GROUPS variable in :file:`csit/bootstrap.sh` file. The VIRL host to run

+VIRL simulation is selected based on least load algorithm per VIRL simulation.

 

 Every VIRL simulation uses the same three-node - Traffic Generator (TG node) and

 two Systems Under Test (SUT1 and SUT2) - "double-ring" topology. The appropriate

 pre-built VPP packages built by Jenkins for the patch under review are then

-installed on the two SUTs, along with their /etc/vpp/startup.conf file, in all

-VIRL simulations.

+installed on the two SUTs, along with their :file:`/etc/vpp/startup.conf` file,

+in all VIRL simulations.

 

 SUT Configuration - VIRL Guest VM

 ---------------------------------

@@ -66,26 +66,26 @@ been tested with, is the following:
 #. **Ubuntu VIRL image**

 

    This image implies Ubuntu 16.04.1 LTS, current as of yyyy-mm-dd (that is,

-   package versions are those that would have been installed by a "apt-get

-   update", "apt-get upgrade" on that day), produced by CSIT disk image build

-   scripts.

-   

+   package versions are those that would have been installed by a

+   :command:`apt-get update`, :command:`apt-get upgrade` on that day), produced

+   by CSIT disk image build scripts.

+

    The exact list of installed packages and their versions (including the Linux

    kernel package version) are included in `VIRL images lists`_.

-   

-   A replica of this VM image can be built by running the "build.sh" script in

-   CSIT repository.

+

+   A replica of this VM image can be built by running the :command:`build.sh`

+   script in CSIT repository.

 

 #. **CentOS VIRL image**

 

    The Centos7.3 image is ready to be used but no tests running on it now.

    Corresponding Jenkins jobs are under preparation.

-   

+

    The exact list of installed packages and their versions (including the Linux

    kernel package version) are included in `VIRL images lists`_.

-   

-   A replica of this VM image can be built by running the "build.sh" script in

-   CSIT repository.

+

+   A replica of this VM image can be built by running the :command:`build.sh`

+   script in CSIT repository.

 

 #. **Nested VM image**