docs: better docs, mv doxygen to sphinx

This patch refactors the VPP sphinx docs
in order to make it easier to consume
for external readers as well as VPP developers.

It also makes sphinx the single source
of documentation, which simplifies maintenance
and operation.

Most important updates are:

- reformat the existing documentation as rst
- split RELEASE.md and move it into separate rst files
- remove section 'events'
- remove section 'archive'
- remove section 'related projects'
- remove section 'feature by release'
- remove section 'Various links'
- make (Configuration reference, CLI docs,
  developer docs) top level items in the list
- move 'Use Cases' as part of 'About VPP'
- move 'Troubleshooting' as part of 'Getting Started'
- move test framework docs into 'Developer Documentation'
- add a 'Contributing' section for gerrit,
  docs and other contributer related infos
- deprecate doxygen and test-docs targets
- redirect the "make doxygen" target to "make docs"

Type: refactor

Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>

1 files changed, 66 insertions, 0 deletions

diff --git a/docs/usecases/contiv/VMWARE_FUSION_HOST.rst b/docs/usecases/contiv/VMWARE_FUSION_HOST.rst
new file mode 100644
index 00000000000..6ddc66546c0
--- /dev/null
+++ b/docs/usecases/contiv/VMWARE_FUSION_HOST.rst
@@ -0,0 +1,66 @@
+Preparing a VmWare Fusion Host
+==============================
+
+The *vmxnet3 driver* is required on a GigE Network Adapter used by VPP.
+On VmWare Fusion, the default Network Adapter driver is an *Intel
+82545EM (e1000)*, and there is no GUI to change it to *vmxnet3*. The
+change must be done manually in the VM’s configuration file as follows:
+
+-  Bring up the VM library window: **Window -> Virtual Machine Library**
+
+-  Right click on the VM where you want to change the driver:
+   <*VM-Name*> **-> Show in Finder**. This pops up a new Finder window
+   with a line for each VM that Fusion knows about.
+
+-  Right click on the VM where you want to change the driver:
+   <*VM-Name*> **-> Show package contents**. This brings up a window
+   with the contents of the package.
+
+-  Open the file <*VM-Name*> **.vmx** with your favorite text editor.
+
+-  For each Network Adapter that you want used by VPP, look for the
+   Network Adapter’s driver configuration. For example, for the VM’s
+   first Network Adapter look for:
+
+   ::
+
+      ethernet0.virtualDev = "e1000"
+
+   Replace ``e1000`` with ``vmxnet3``:
+
+   ::
+
+      ethernet0.virtualDev = "vmxnet3"
+
+   and restart the VM.
+
+If you replaced the driver on your VM’s primary Network Adapter, you
+will have to change the primary network interface configuration in
+Linux.
+
+First, get the new primary network interface name:
+
+::
+
+   sudo lshw -class network -businfo
+
+   Bus info          Device      Class          Description
+   ========================================================
+   pci@0000:03:00.0  ens160      network        VMXNET3 Ethernet Controller
+
+Replace the existing primary network interface name in
+``/etc/network/interfaces`` with the above device name (ens160): \``\` #
+This file describes the network interfaces available on your system, #
+and how to activate them. For more information, see interfaces(5).
+
+source /etc/network/interfaces.d/\*
+
+The loopback network interface
+==============================
+
+auto lo iface lo inet loopback
+
+The primary network interface
+=============================
+
+auto ens160 iface ens160 inet dhcp