From 10649b3ce07bbb3144d196c403d8c1fa65ddf116 Mon Sep 17 00:00:00 2001 From: Peter Mikus Date: Mon, 22 May 2017 09:35:17 +0200 Subject: CSIT-612 Report: Minimization of hand-crafted content. - replace dynamic text content and links by variables. Change-Id: I1a7ec371fc80af3c9dd416bf91dd2c639097cf1e Signed-off-by: Peter Mikus --- docs/report/introduction/csit_tag_description.rst | 2 +- docs/report/introduction/csit_test_naming.rst | 6 +++--- docs/report/introduction/general_notes.rst | 10 ++++++---- docs/report/introduction/overview.rst | 12 ++++++------ 4 files changed, 16 insertions(+), 14 deletions(-) (limited to 'docs/report/introduction') diff --git a/docs/report/introduction/csit_tag_description.rst b/docs/report/introduction/csit_tag_description.rst index 968db02c61..5ea6c7fc04 100644 --- a/docs/report/introduction/csit_tag_description.rst +++ b/docs/report/introduction/csit_tag_description.rst @@ -5,7 +5,7 @@ All CSIT test cases are labelled with Robot Framework tags used to allow for easy test case type identification, test case grouping and selection for execution. Following sections list currently used CSIT TAGs and their documentation based on the content of -`tag_documentation rst file `_. +`tag documentation rst file`_. Topology TAGs ------------- diff --git a/docs/report/introduction/csit_test_naming.rst b/docs/report/introduction/csit_test_naming.rst index a4de765e0a..682fcd941a 100644 --- a/docs/report/introduction/csit_test_naming.rst +++ b/docs/report/introduction/csit_test_naming.rst @@ -5,12 +5,12 @@ Background ---------- CSIT |release| follows a common structured naming convention for all -performance and system functional tests, introduced in CSIT rls1701. +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 -`CSIT test naming wiki page `_. Below -few illustrative examples of the naming usage for test suites across CSIT +`CSIT test naming wiki page `_. +Below few illustrative examples of the naming usage for test suites across CSIT performance, functional and HoneyComb management test areas. Naming Convention diff --git a/docs/report/introduction/general_notes.rst b/docs/report/introduction/general_notes.rst index ebb73cdc93..5015b6bb16 100644 --- a/docs/report/introduction/general_notes.rst +++ b/docs/report/introduction/general_notes.rst @@ -40,9 +40,11 @@ is listed separately, as follows: functionality of VPP. Tests cover a range of CRUD operations executed against VPP. -In addition to above, CSIT |release| report does also include VPP unit test results. VPP unit tests are developed within the FD.io VPP project and as they complement CSIT system functional tests, they are provided mainly as a reference and to -provide a more complete view of automated testing executed against -VPP-17.04 release. +In addition to above, CSIT |release| report does also include VPP unit test +results. VPP unit tests are developed within the FD.io VPP project and as they +complement CSIT system functional tests, they are provided mainly as a reference +and to provide a more complete view of automated testing executed against +|vpp-release|. FD.io CSIT system is developed using two main coding platforms: Robot Framework (RF) and Python. CSIT |release| source code for the executed test @@ -52,4 +54,4 @@ obtained by cloning CSIT git repository - "git clone https://gerrit.fd.io/r/csit". The CSIT testing virtual environment can be run on a local computer workstation (laptop, server) using Vagrant by following the instructions in `CSIT tutorials -`_. \ No newline at end of file +`_. diff --git a/docs/report/introduction/overview.rst b/docs/report/introduction/overview.rst index 97b6abc5bb..30f62a90e2 100644 --- a/docs/report/introduction/overview.rst +++ b/docs/report/introduction/overview.rst @@ -3,17 +3,17 @@ Overview This is the **F**\ast **D**\ata **I**/**O** Project (**FD.io**) **C**\ontinuous **S**\ystem **I**\ntegration and **T**\esting (**CSIT**) project report for CSIT -|release| system testing of VPP-17.04 release. +|release| system testing of |vpp-release|. The report describes CSIT functional and performance tests and their continuous execution delivered in CSIT |release|. A high-level overview is provided for each CSIT test environment running in Linux Foundation (LF) FD.io Continuous Performance Labs. This is followed by summary of all executed tests -against the VPP-17.04 release and associated FD.io projects and sub-systems (HoneyComb, DPDK), -CSIT |release| release notes, result highlights and known issues discovered in CSIT. More -detailed description of each environment, pointers to CSIT test code -documentation and detailed test resuls with links to the source data files are -also provided. +against the |vpp-release| and associated FD.io projects and sub-systems +(HoneyComb, DPDK), CSIT |release| release notes, result highlights and known +issues discovered in CSIT. More detailed description of each environment, +pointers to CSIT test code documentation and detailed test resuls with links to +the source data files are also provided. CSIT |release| report contains following main sections and sub-sections: -- cgit 1.2.3-korg