aboutsummaryrefslogtreecommitdiffstats
path: root/resources/tools/doc_gen/src/index.rst
diff options
context:
space:
mode:
authorTibor Frank <tifrank@cisco.com>2017-01-27 14:50:31 +0100
committerPeter Mikus <pmikus@cisco.com>2017-01-31 12:31:25 +0000
commit5362fa4f79de701a737b4d1ff794ad4e513f6486 (patch)
tree249099547d2f8a272d7c12bbfb889eb56fc7cb65 /resources/tools/doc_gen/src/index.rst
parentffe30437f37176e745e8272a91ddd52587f8bcda (diff)
CSIT doc: Add chapter numbering
Change-Id: I5cdcda0461e6f4bdabd91ea440edf7a71db9afd9 Signed-off-by: Tibor Frank <tifrank@cisco.com>
Diffstat (limited to 'resources/tools/doc_gen/src/index.rst')
-rw-r--r--resources/tools/doc_gen/src/index.rst78
1 files changed, 7 insertions, 71 deletions
diff --git a/resources/tools/doc_gen/src/index.rst b/resources/tools/doc_gen/src/index.rst
index b92ecd6bd4..77c6966150 100644
--- a/resources/tools/doc_gen/src/index.rst
+++ b/resources/tools/doc_gen/src/index.rst
@@ -1,78 +1,14 @@
-.. |csit| replace:: Continuous System Integration and Testing
-
-
-|csit| Description
-==================
-
-#. Development of software code for fully automated VPP code testing, functionality, performance, regression and new functions.
-#. Execution of CSIT test suites on VPP code running on LF FD.io virtual and physical compute environments.
-#. Integration with FD.io continuous integration systems (Gerrit, Jenkins and such).
-#. Identified existing FD.io project dependencies and interactions:
- - vpp - Vector Packet Processing.
- - honeycomb - Honeycomb Agent for management plane testing.
- - ci-management - Management repo for Jenkins Job Builder, script and management related to the Jenkins CI configuration.
-
-Project Scope
--------------
-
-#. Automated regression testing of VPP code changes
- - Functionality of VPP data plane, network control plane, management plane against functional specifications.
- - Performance of VPP data plane including non-drop-rate packet throughput and delay, against established reference benchmarks.
- - Performance of network control plane against established reference benchmarks.
- - Performance of management plane against established reference benchmarks.
-#. Test case definitions driven by supported and planned VPP functionality, interfaces and performance:
- - Uni-dimensional tests: Data plane, (Network) Control plane, Management plane.
- - Multi-dimensional tests: Use case driven.
-#. Integration with FD.io Continuous Integration system including FD.io Gerrit and Jenkins
- - Automated test execution triggered by VPP-VERIFY jobs other VPP and CSIT project jobs.
-#. Integration with LF VPP test execution environment
- - Functional tests execution on LF hosted VM environment.
- - Performance and functional tests execution on LF hosted physical compute environment.
- - Subset of tests executed on LF hosted physical compute running VIRL (Virtual Internet Routing Lab).
-
-|csit| Documentation
---------------------
-
-Python Library
-##############
+Contents
+--------
.. toctree::
- :maxdepth: 2
+ :numbered:
+ :maxdepth: 1
:glob:
-
- resources.libraries.python
-
-Robot Library
-#############
-.. toctree::
- :maxdepth: 2
- :glob:
-
+ overview
+ resources.libraries.python
resources.libraries.robot
-
-Functional Tests
-################
-
-.. toctree::
- :maxdepth: 3
- :glob:
-
tests.func
-
-Performance Tests
-#################
-
-.. toctree::
- :maxdepth: 2
- :glob:
-
tests.perf
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+ indices