summaryrefslogtreecommitdiffstats
path: root/docs/overview
diff options
context:
space:
mode:
Diffstat (limited to 'docs/overview')
-rw-r--r--docs/overview/index.rst10
-rw-r--r--docs/overview/whatisvpp/dataplane.rst6
-rw-r--r--docs/overview/whatisvpp/developer.rst2
-rw-r--r--docs/overview/whatisvpp/fast.rst4
4 files changed, 17 insertions, 5 deletions
diff --git a/docs/overview/index.rst b/docs/overview/index.rst
index d3da0e211fa..8d1e434d848 100644
--- a/docs/overview/index.rst
+++ b/docs/overview/index.rst
@@ -1,8 +1,14 @@
.. _overview:
-=========================================
+==========
Overview
-=========================================
+==========
+
+This section discusses the following information:
+
+* What VPP is, what packet processing provides and the benefits VPP provides
+
+
.. toctree::
:maxdepth: 1
diff --git a/docs/overview/whatisvpp/dataplane.rst b/docs/overview/whatisvpp/dataplane.rst
index 9113038fc57..256165f4f8c 100644
--- a/docs/overview/whatisvpp/dataplane.rst
+++ b/docs/overview/whatisvpp/dataplane.rst
@@ -1,8 +1,10 @@
.. _packet-processing:
-=================
+===================
Packet Processing
-=================
+===================
+
+This section identifies different components of packet processing and describes their benefits:
* Layer 2 - 4 Network Stack
diff --git a/docs/overview/whatisvpp/developer.rst b/docs/overview/whatisvpp/developer.rst
index a0bb2d451c0..57000d45880 100644
--- a/docs/overview/whatisvpp/developer.rst
+++ b/docs/overview/whatisvpp/developer.rst
@@ -4,6 +4,8 @@
Developer Friendly
==================
+This section describes the different ways VPP is friendly to developers:
+
* Extensive runtime counters; throughput, `intructions per cycle <https://en.wikipedia.org/wiki/Instructions_per_cycle>`_, errors, events etc.
* Integrated pipeline tracing facilities
* Multi-language API bindings
diff --git a/docs/overview/whatisvpp/fast.rst b/docs/overview/whatisvpp/fast.rst
index b04c12fbe7b..9e9e314809c 100644
--- a/docs/overview/whatisvpp/fast.rst
+++ b/docs/overview/whatisvpp/fast.rst
@@ -4,7 +4,9 @@
Fast, Scalable and Deterministic
================================
-* `Continuous integration and system testing <https://wiki.fd.io/view/CSIT#Start_Here>`_
+This section describes the ways that VPP is fast, scalable and deterministic:
+
+* `Continuous integration and system testing (CSIT) <https://wiki.fd.io/view/CSIT#Start_Here>`_
* Including continuous & extensive, latency and throughput testing