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>

1 files changed, 0 insertions, 147 deletions

diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
deleted file mode 100644
index cbb44c5..0000000
--- a/docs/release/release-notes/release-notes.rst
+++ /dev/null
@@ -1,147 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) Cisco Systems, Inc
-
-RELEASE NOTES
-+++++++++++++
-
-Release 3.6.2
-=============
-
-- NFVBENCH-152 Add service_mode method for debugging purpose
-- NFVBENCH-150 Add support for VXLAN latency
-- NFVBENCH-146 Add cache_size option
-- NFVBENCH-151 Allocate hugepages on two NUMAs in nfvbenchvm
-- NFVBENCH-149 Negative latency exception during NDR/PDR search
-- NFVBENCH-148 Increase the waiting time based on # of instances
-
-Release 3.5.1
-=============
-
-- NFVBENCH-147 Incorrect URL used for admin check in credentials
-- Release the validation check for VxLAN networks
-- NFVBENCH-145 Config file not found. No explicit error
-- NFVBENCH-144 Trex cannot take account NFVBench config (platform thread id 0)
-
-- NFVBENCH-140 Retrieve High Dynamic Range latency histograms with TRex v2.59
-- NFVBENCH-143 Trex cannot start due to invalid config (platform None)
-- NFVBENCH-141 Fix Openstack user admin role check
-- NFVBENCH-139 Fix master_thread_id and latency_thread_id property checking
-- NFVBENCH-95 Add HdrHistogram encodes returned by TRex to JSON results
-- NFVBENCH-138 Use yaml.safe_load() instead of unsafe yaml load
-- NFVBENCH-137 NFVbench generates wrong L4 checksums for VxLAN traffic
-
-Release 3.4.0
-=============
-
-- Add L3 traffic management with Neutron routers
-
-
-Release 3.3.0
-=============
-
-Major release highlights:
-
-- VxLAN support
-- test VM can now have idle interfaces
-- test VM can be launched with multiqueue enabled
-- upgrade to TRex v2.56
-
-
-Release 2.0
-===========
-NFVbench will now follow its own project release numbering (x.y.z) which is independent of the OPNFV release numbering (opnfv-x.y.z)
-
-Major release highlights:
-
-- Dedicated edge networks for each chain
-- Enhanced chain analysis
-- Code refactoring and enhanced unit testing
-- Miscellaneous enhancement
-
-Dedicated edge networks for each chain
---------------------------------------
-NFVbench 1.x only supported shared edge networks for all chains.
-For example, 20xPVP would create only 2 edge networks (left and right) shared by all chains.
-With NFVbench 2.0, chain networks are dedicated (unshared) by default with an option in
-the nfvbench configuration to share them. A 20xPVP run will create 2x20 networks instead.
-
-Enhanced chain analysis
------------------------
-The new chain analysis improves at multiple levels:
-
-- there is now one table for each direction (forward and reverse) that both read from left to right
-- per-chain packet counters and latency
-- all-chain aggregate packet counters and latency
-- supports both shared and dedicated chain networks
-
-Code refactoring and enhanced unit testing
-------------------------------------------
-The overall code structure is now better partitioned in the following functions:
-
-- staging and resource discovery
-- traffic generator
-- stats collection
-
-The staging algorithm was rewritten to be:
-
-- a lot more robust to errors and to handle better resource reuse use cases.
-  For example when a network with a matching name is discovered the new code will verify that the
-  network is associated to the right VM instance
-- a lot more strict when it comes to the inventory of MAC addresses. For example the association
-  from each VM MAC to a chain index for each Trex port is handled in a much more strict manner.
-
-Although not all code is unit tested, the most critical parts are unit tested with the use of
-the mock library. The resulting unit test code can run in isolation without needing a real system under test.
-
-
-OPNFV Fraser Release
-====================
-
-Over 30 Jira tickets have been addressed in this release (Jira NFVBENCH-55 to NFVBENCH-78)
-
-The Fraser release adds the following new features:
-
-- support for benchmarking non-OpenStack environments (with external setup and no OpenStack openrc file)
-- PVVP packet path with SRIOV at the edge and vswitch between VMs
-- support logging events and results through fluentd
-
-Enhancements and main bug fixes:
-
-- end to end connectivity for larger chain count is now much more accurate for large chain count - avoiding excessive drops
-- use newer version of TRex (2.32)
-- use newer version of testpmd DPDK
-- NDR/PDR uses actual TX rate to calculate drops - resulting in more accurate results
-- add pylint to unit testing
-- add self sufficient and standalone unit testing (without actual testbed)
-
-
-OPNFV Euphrates Release
-=======================
-
-This is the introductory release for NFVbench. In this release, NFVbench provides the following features/capabilities:
-
-- standalone installation with a single Docker container integrating the open source TRex traffic generator
-- can measure data plane performance for any NFVi full stack
-- can setup automatically service chains with the following packet paths:
-    - PVP (physical-VM-physical)
-    - PVVP (physical-VM-VM-physical) intra-node and inter-node
-- can setup multiple service chains
-    - N * PVP
-    - N * PVVP
-- supports any external service chain (pre-set externally) that can do basic IPv4 routing
-- can measure
-    - drop rate and latency for any given fixed rate
-    - NDR (No Drop Rate) and PDR (Partial Drop Rate) with configurable drop rates
-- traffic specification
-    - any fixed frame size or IMIX
-    - uni or bidirectional traffic
-    - any number of flows
-    - vlan tagging can be enabled or disabled
-- user interface:
-    - CLI
-    - REST+socketIO
-- fully configurable runs with yaml-JSON configuration
-- detailed results in JSON format
-- summary tabular results
-- can send logs and results to one or more fluentd aggregators (per configuration)