aboutsummaryrefslogtreecommitdiffstats
path: root/docs/user/index.rst
diff options
context:
space:
mode:
authorGwenael Lambrouin <gwenael.lambrouin@orange.com>2023-02-08 13:20:45 +0100
committerGwenael Lambrouin <gwenael.lambrouin@orange.com>2023-02-08 13:20:59 +0100
commitb33d3b4bc7ae7113ffca9b049eef1be172e22d29 (patch)
tree8942a41eaf36dcae30147f3bae80669647e79567 /docs/user/index.rst
parent1e6a2788ca3118885c64276dc862f98d53d4ac99 (diff)
docs: refresh & structure overhaul
Rework the doc in order to improve the navigation experience and to make it easier to update the doc: - simplify structure: docs/{release-notes,user,developer} - recreate sphinx config file - switch theme from opnfv to piccolo - fix minor rst issues - fix external references - add missing license headers (add a short header with copyright and SPDX license identifier to the files lacking the information. The header is based on https://github.com/david-a-wheeler/spdx-tutorial) Change-Id: I9a1135a2873d9955beb26760e0cb6c5d6c1326bd Signed-off-by: Gwenael Lambrouin <gwenael.lambrouin@orange.com>
Diffstat (limited to 'docs/user/index.rst')
-rw-r--r--docs/user/index.rst35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/user/index.rst b/docs/user/index.rst
new file mode 100644
index 0000000..65b6c2a
--- /dev/null
+++ b/docs/user/index.rst
@@ -0,0 +1,35 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Cisco Systems, Inc
+
+
+.. NFVBench documentation master file, created by
+ sphinx-quickstart on Thu Sep 29 14:25:18 2016.
+
+
+*******************
+NFVbench User Guide
+*******************
+
+The NFVbench tool provides an automated way to measure the network performance for the most common data plane packet flows on any OpenStack system.
+It is designed to be easy to install and easy to use by non experts (no need to be an expert in traffic generators and data plane performance testing).
+
+
+Table of Contents
+
+.. toctree::
+ :maxdepth: 3
+
+ readme
+ installation
+ examples
+ advanced
+ pvpl3
+ xtesting
+ mpls
+ extchains
+ fluentd
+ kibana
+ sriov
+ server
+ faq