docs: better docs, mv doxygen to sphinx

[vpp.git] / docs / aboutvpp / performance.rst

diff --git a/docs/whatisvpp/performance.rst b/docs/aboutvpp/performance.rst
similarity index 91%
rename from docs/whatisvpp/performance.rst
rename to docs/aboutvpp/performance.rst
index d7af24a..c818ff6 100644 (file)
--- a/docs/whatisvpp/performance.rst
+++ b/docs/aboutvpp/performance.rst
@@ -18,9 +18,9 @@ Included are the following.
 
 * The same optimized code-paths run execute on the host, and inside VMs and Linux containers
 * Leverages best-of-breed open source driver technology: `DPDK <https://www.dpdk.org/>`_
-* Tested at scale; linear core scaling, tested with millions of flows and mac addresses  
+* Tested at scale; linear core scaling, tested with millions of flows and mac addresses
 
-These features have been designed to take full advantage of common micro-processor optimization techniques, such as: 
+These features have been designed to take full advantage of common micro-processor optimization techniques, such as:
 
 * Reducing cache and TLS misses by processing packets in vectors
 * Realizing `IPC <https://en.wikipedia.org/wiki/Instructions_per_cycle>`_ gains with vector instructions such as: SSE, AVX and NEON
@@ -28,8 +28,8 @@ These features have been designed to take full advantage of common micro-process
 * Cache-lined aligned buffers for cache and memory efficiency
 
 
-Continuous System Integration and Testing (CSIT)
-------------------------------------------------
+CSIT
+----
 
 The Continuous System Integration and Testing (CSIT) project provides functional and performance
 testing for FD.io VPP. This testing is focused on functional and performance regressions. The results
@@ -42,12 +42,12 @@ For more about CSIT checkout the following links:
 * `VPP Performance Dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_
 
 
-CSIT Packet Throughput examples
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Packet Throughput examples
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Following are pointers to a few of the CSIT test reports. The test's titles read like this:
 
-<packet size>-<number of threads><number of cores>-<test>-<interface type> 
+<packet size>-<number of threads><number of cores>-<test>-<interface type>
 
 For example the test with the title 64b-2t1c-l2switching-base-i40e is the
 test that does l2 switching using 64 byte packets, 2 threads, 1 core using an i40e
@@ -61,7 +61,7 @@ Here are a few examples:
 
 
 Trending Throughput Graphs
-^^^^^^^^^^^^^^^^^^^^^^^^^^ 
+^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 These are some of the trending packet throughput graphs from the CSIT `trending dashboard <https://docs.fd.io/csit/master/trending/introduction/index.html>`_. **Please note that**, performance in the trending graphs will change on a nightly basis in line with the software development cycle: