docs: refresh & structure overhaul 64/73864/1
authorGwenael Lambrouin <gwenael.lambrouin@orange.com>
Wed, 8 Feb 2023 12:20:45 +0000 (13:20 +0100)
committerGwenael Lambrouin <gwenael.lambrouin@orange.com>
Wed, 8 Feb 2023 12:20:59 +0000 (13:20 +0100)
commitb33d3b4bc7ae7113ffca9b049eef1be172e22d29
tree8942a41eaf36dcae30147f3bae80669647e79567
parent1e6a2788ca3118885c64276dc862f98d53d4ac99
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>
68 files changed:
INFO.yaml
README.rst
docs/Makefile
docs/conf.py
docs/conf.yaml [deleted file]
docs/developer/building.rst [moved from docs/development/building/build.rst with 98% similarity]
docs/developer/design/design.rst [moved from docs/development/design/design.rst with 96% similarity]
docs/developer/design/index.rst [moved from docs/development/design/index.rst with 71% similarity]
docs/developer/design/ndrpdr.rst [moved from docs/development/design/ndrpdr.rst with 100% similarity]
docs/developer/design/overview.rst [moved from docs/development/overview/overview.rst with 94% similarity]
docs/developer/design/traffic_desc.rst [moved from docs/development/design/traffic_desc.rst with 99% similarity]
docs/developer/design/versioning.rst [moved from docs/development/design/versioning.rst with 100% similarity]
docs/developer/index.rst [moved from docs/development/index.rst with 63% similarity]
docs/developer/nfvbenchvm.rst [moved from nfvbenchvm/README.rst with 97% similarity]
docs/developer/testing-nfvbench.rst [moved from docs/testing/developer/devguide/testing-nfvbench.rst with 98% similarity]
docs/development/building/index.rst [deleted file]
docs/development/overview/index.rst [deleted file]
docs/index.rst
docs/make.bat [new file with mode: 0644]
docs/release-notes/index.rst [moved from docs/release/release-notes/index.rst with 72% similarity]
docs/release-notes/nfvbench-release-notes.rst [moved from docs/release/release-notes/release-notes.rst with 99% similarity]
docs/release-notes/nfvbenchvm-release-notes.rst [moved from docs/release/release-notes/nfvbenchvm-release-notes.rst with 100% similarity]
docs/requirements.txt
docs/testing/developer/devguide/index.rst [deleted file]
docs/testing/index.rst [deleted file]
docs/testing/user/configguide/configguide.rst [deleted file]
docs/testing/user/configguide/index.rst [deleted file]
docs/testing/user/userguide/_static/custom.css [deleted file]
docs/testing/user/userguide/_templates/layout.html [deleted file]
docs/testing/user/userguide/conf.py [deleted file]
docs/user/advanced.rst [moved from docs/testing/user/userguide/advanced.rst with 99% similarity]
docs/user/examples.rst [moved from docs/testing/user/userguide/examples.rst with 100% similarity]
docs/user/extchains.rst [moved from docs/testing/user/userguide/extchains.rst with 100% similarity]
docs/user/faq.rst [moved from docs/testing/user/userguide/faq.rst with 100% similarity]
docs/user/fluentd.rst [moved from docs/testing/user/userguide/fluentd.rst with 100% similarity]
docs/user/hw_requirements.rst [moved from docs/testing/user/userguide/hw_requirements.rst with 100% similarity]
docs/user/images/extchain-config.png [moved from docs/testing/user/userguide/images/extchain-config.png with 100% similarity]
docs/user/images/nfvbench-all-sriov-pvvp.png [moved from docs/testing/user/userguide/images/nfvbench-all-sriov-pvvp.png with 100% similarity]
docs/user/images/nfvbench-all-sriov-pvvp2.png [moved from docs/testing/user/userguide/images/nfvbench-all-sriov-pvvp2.png with 100% similarity]
docs/user/images/nfvbench-ext-multi-vlans.png [moved from docs/testing/user/userguide/images/nfvbench-ext-multi-vlans.png with 100% similarity]
docs/user/images/nfvbench-ext-shared.png [moved from docs/testing/user/userguide/images/nfvbench-ext-shared.png with 100% similarity]
docs/user/images/nfvbench-kibana-filter-kql.png [moved from docs/testing/user/userguide/images/nfvbench-kibana-filter-kql.png with 100% similarity]
docs/user/images/nfvbench-kibana-filter.png [moved from docs/testing/user/userguide/images/nfvbench-kibana-filter.png with 100% similarity]
docs/user/images/nfvbench-kibana-gbps-line.png [moved from docs/testing/user/userguide/images/nfvbench-kibana-gbps-line.png with 100% similarity]
docs/user/images/nfvbench-kibana-pps-scatter.png [moved from docs/testing/user/userguide/images/nfvbench-kibana-pps-scatter.png with 100% similarity]
docs/user/images/nfvbench-kibana-pps-theoretical.png [moved from docs/testing/user/userguide/images/nfvbench-kibana-pps-theoretical.png with 100% similarity]
docs/user/images/nfvbench-kibana-zoom-selection.png [moved from docs/testing/user/userguide/images/nfvbench-kibana-zoom-selection.png with 100% similarity]
docs/user/images/nfvbench-kibana.png [moved from docs/testing/user/userguide/images/nfvbench-kibana.png with 100% similarity]
docs/user/images/nfvbench-npvp.png [moved from docs/testing/user/userguide/images/nfvbench-npvp.png with 100% similarity]
docs/user/images/nfvbench-pvp.png [moved from docs/testing/user/userguide/images/nfvbench-pvp.png with 100% similarity]
docs/user/images/nfvbench-pvpl3.png [moved from docs/testing/user/userguide/images/nfvbench-pvpl3.png with 100% similarity]
docs/user/images/nfvbench-pvvp.png [moved from docs/testing/user/userguide/images/nfvbench-pvvp.png with 100% similarity]
docs/user/images/nfvbench-pvvp2.png [moved from docs/testing/user/userguide/images/nfvbench-pvvp2.png with 100% similarity]
docs/user/images/nfvbench-sriov-pvp.png [moved from docs/testing/user/userguide/images/nfvbench-sriov-pvp.png with 100% similarity]
docs/user/images/nfvbench-sriov-pvvp.png [moved from docs/testing/user/userguide/images/nfvbench-sriov-pvvp.png with 100% similarity]
docs/user/images/nfvbench-sriov-pvvp2.png [moved from docs/testing/user/userguide/images/nfvbench-sriov-pvvp2.png with 100% similarity]
docs/user/images/nfvbench-trex-setup.png [moved from docs/testing/user/userguide/images/nfvbench-trex-setup.png with 100% similarity]
docs/user/images/nfvbench-xtesting.png [moved from docs/testing/user/userguide/images/nfvbench-xtesting.png with 100% similarity]
docs/user/index.rst [moved from docs/testing/user/userguide/index.rst with 95% similarity]
docs/user/installation.rst [moved from docs/testing/user/userguide/installation.rst with 100% similarity]
docs/user/kibana.rst [moved from docs/testing/user/userguide/kibana.rst with 95% similarity]
docs/user/mpls.rst [moved from docs/testing/user/userguide/mpls.rst with 97% similarity]
docs/user/pvpl3.rst [moved from docs/testing/user/userguide/pvpl3.rst with 96% similarity]
docs/user/quickstart_docker.rst [moved from docs/testing/user/userguide/quickstart_docker.rst with 100% similarity]
docs/user/readme.rst [moved from docs/testing/user/userguide/readme.rst with 100% similarity]
docs/user/server.rst [moved from docs/testing/user/userguide/server.rst with 100% similarity]
docs/user/sriov.rst [moved from docs/testing/user/userguide/sriov.rst with 100% similarity]
docs/user/xtesting.rst [moved from docs/testing/user/userguide/xtesting.rst with 100% similarity]