diff options
| -rw-r--r-- | docs/gettingstarted/developers/gitreview.rst | 17 | ||||
| -rw-r--r-- | docs/index.rst | 20 |
2 files changed, 27 insertions, 10 deletions
diff --git a/docs/gettingstarted/developers/gitreview.rst b/docs/gettingstarted/developers/gitreview.rst index a962d25e4fd..3f865c159a2 100644 --- a/docs/gettingstarted/developers/gitreview.rst +++ b/docs/gettingstarted/developers/gitreview.rst @@ -83,7 +83,22 @@ For example for a document with only patches you should add the tag **docs:**. .. code-block:: console $ git add <filename> - $ git commit -s -m "<*TAG*>: <*COMMIT_MESSAGE*>" + $ git commit -s + +The commit comment should have something like the following comment: + +.. code-block:: console + + docs: A brief description of the commit + + Type: Improvement (The type of commit this could be: Improvement, Fix or Feature) + + A detailed description of the commit could go here. + +Push the patch for review. + +.. code-block:: console + $ git review If you are creating a draft, meaning you do not want your changes reviewed yet, do the following: diff --git a/docs/index.rst b/docs/index.rst index 391c5832820..a1917b35f5e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -10,21 +10,23 @@ What is the Vector Packet Processor (VPP) FD.io's Vector Packet Processor (VPP) is a fast, scalable layer 2-4 multi-platform network stack. It runs in `Linux Userspace <https://en.wikipedia.org/wiki/User_space>`_ on multiple architectures including x86, ARM, and Power architectures. -VPP is built using the `Dataplane Development Kit (DPDK) <https://en.wikipedia.org/wiki/Data_Plane_Development_Kit>`_. -VPP benefits include high performance, proven technology, modularity, -and a rich feature set. +VPP's high performance network stack is quickly becoming the network stack of +choice for applications around the world. + +VPP is continually being enhanced through the extensive use of plugins. The +`Data Plane Development Kit (DPDK) <https://en.wikipedia.org/wiki/Data_Plane_Development_Kit>`_ +is a great example of this. It provides some important features and drivers +for VPP. VPP supports integration with OpenStack and Kubernetes. Network management features include configuration, counters, sampling and -more. For developers, VPP includes plugin extensibility, -high-performance event-logging, and multiple kinds of packet -tracing. Development debug images include complete symbol tables, and -extensive consistency checking. +more. For developers, VPP includes high-performance event-logging, +and multiple kinds of packet tracing. Development debug images +include complete symbol tables, and extensive consistency checking. Some VPP Use-cases include vSwitches, vRouters, Gateways, Firewalls -and Load Balancers, to name a few. Out of the box, VPP can work as a -software development kit or an appliance. +and Load Balancers, to name a few. For more details click on the links below or press next. |