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, 758 insertions, 212 deletions

diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index f5cbf4e0802..53f34c50fd1 100644
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -1,37 +1,615 @@
-aarch
-Aarch
 AArch
-abf
-accelera
 ACK
-acl
 ACL
 ACLs
+API
+ASan
+Aarch
+Agg
+Ajourn
+Ananyev
+govpp
+unserialization
+archs
+symlink
+libmemf
+libme
+mif
+pwait
+tunnelling
+ctx
+efd
+optimised
+strerror
+syscall
+ligato
+congruential
+phc
+Anycast
+Arp
+icmpr
+pps
+bc
+midchain
+Midchain
+fmt
+intfcs
+libmemifs
+gethostbyname
+multithreading
+sourceNATing
+Mapp
+Headend
+pgm
+retransmits
+cheng
+iccrg
+filsfils
+Datagram
+syscalls
+Altivec
+memcpy
+mmap
+Warshall
+XXhash
+headend
+Fortville
+openbsd
+zx
+openbsd
+Diffie
+github
+criterias
+daddr
+gettingstarted
+Arping
+Arping
+Autogenerated
+BGP
+adaptively
+Defensic
+aa
+BIHASH
+BV
+Backtrace
+allocatable
+consumability
+Usermode
+isn
+shouldn
+combinatorial
+ufwd
+Barach
+Bfd
+receival
+ap
+Bihash
+emphasise
+Bihashes
+neighbouring
+Brockners
+LimitCORE
+eXtensible
+aabb
+aftr
+Recircs
+Bufmon
+iPv
+Builtinurl
+deallocation
+nonaddress
+CMakeLists
+CNat
+CPPFLAGS
+Castelino
+Centos
+efp
+preallocation
+Cisco
+Clib
+Cmake
+Cnat
+ufwd
+runit
+rulebase
+seatbelt
+iWARP
+strongswan
+unapplies
+subgraphs
+Codenomicon
+eeff
+unapply
+analyse
+Colour
+subdirectories
+Comms
+srcIP
+Config
+unreachables
+ager
+ConnectX
+str
+undirected
+Contiv
+reselects
+Coras
+unmanaged
+Coredumps
+Coverity
+Crypto
+Cryptodev
+DS
+DSR
+Dataplane
+Dataplanes
+Debuginfo
+Decapsulating
+Dest
+Diffs
+Distro
+Donley
+Doxygen
+Eifel
+Encaps
+Enqueueing
+Enums
+Erns
+Extranets
+FiB
+Flowprobe
+GByte
+GTP
+GbE
+Gbe
+Gbits
+Gbps
+Gbytes
+Geneve
+Gerrit
+GigE
+Gigabit
+Github
+Goncalves
+Gzip
+HQoS
+Heapsize
+Hotkeys
+Huawei
+Hypervisors
+IBverbs
+IKEv2
+IP
+IPsec
+IPv
+IPv4
+Ikev
+Init
+Instantiation
+Integrations
+Interoperation
+Iperf
+Jira
+KMG
+KOC
+KVP
+programmability
+decapsulate
+pseudocode
+libsrtp
+upf
+Konstantynowicz
+Kube
+Kubeadm
+Kubelet
+Kubernetes
+L3XC
+LB
+LDFLAGS
+LLDP
+Linuxcon
+Lldp
+balancer
+balancers
+Lockless
+Loopback
+Lua
+encap
+Luajit
+MPLS
+MPLS
+Maciek
+Makefile
+Makefiles
+Manohar
+Maryam
+Mbytes
+Mdata
+Mellanox
+Memif
+Metadata
+Mfib
+Monroy
+Mpps
+Mss
+Multicast
+Multicore
+Multihoming
+Multiqueue
+Multistream
+Multitenancy
+Mutlithreading
+NIC
+llist
+NSH
+NUMA
+Namespace
+mrvl
+mempool
+localsids
+msgbuf
+logrotate
+auditd
+ndp
+neighbour
+modularity
+masse
+snapcraft
+tgz
+lcov
+cd
+gcovr
+ggcov
+Bn
+Cn
+unmounting
+sealert
+ausearch
+semodule
+Snapcraft
+multipass
+awk
+ldpreload
+iPerf
+xterms
+ps
+centos
+statfs
+proc
+unmounts
+unmount
+fs
+mountpoint
+statSocket
+Unmounting
+fusermount
+Golang
+setUp
+tearDown
+Stdout
+stdout
+testcase
+unittest
+TestVxlan
+UNUP
+pton
+infos
+papi
+setUpClass
+nelts
+portranges
+wasn
+wi
+xcrw
+xcrw
+xtr
+includedir
+iface
+realised
+interoperation
+Infiniband
+Inband
+woohoo
+inex
+inet
+instantiation
+libibverb
+lc
+jitter
+incrementing
+libvppapiclient
+linearization
+recurse
+recirc
+teib
+th
+srcPortDefinition
+srcUP
+ssm
+spinlock
+te
+recode
+srh
+stderr
+sha
+sys
+conn
+sv
+iWARP
+et
+handoffdemo
+syscfg
+hbh
+timebase
+gtp
+fbfc
+tmpl
+preprocessor
+fixup
+psp
+fmask
+extranet
+spd
+DT
+DX
+undefine
+aren
+subgraph
+expander
+encaps
+backwalk
+ccdd
+cdbdec
+centric
+cdba
+cfd
+cksum
+reallocations
+preload
+reachability
+rdtsc
+putatively
+ppc
+pitr
+pmtu
+rekeying
+requeueing
+requeued
+recusive
+requeue
+resolvers
+recurse
+recurses
+ress
+rloc
+rr
+rxandtx
+runnable
+scrollbars
+scrollbar
+tw
+typedef
+wouldn
+zeroize
+untagged
+upstreamed
+vectorized
+vfr
+vtf
+pbb
+petr
+peerings
+pathname
+pipelined
+parsable
+parallelize
+parallelizes
+pipelining
+netdev
+noevaluate
+onlink
+outacl
+preallocated
+nexthop
+nosyslog
+nthrottle
+nsess
+Neighbour
+nbr
+nd
+musdk
+muppet
+makefile
+mult
+Netmap
+Netplan
+mdata
+mroute
+Nsh
+Nstrings
+NxN
+loopId
+macos
+O'Driscoll
+OAM
+Oddbuf
+Openssl
+subnets
+Optimisations
+PCI
+PSP
+Pcap
+Perfmon
+Performan
+Pfister
+Plugin
+Plugins
+Pnat
+PoC
+Policers
+Pollable
+Preallocate
+Prebuilt
+Promisc
+Pseudocode
+Qemu
+QoS
+rss
+strongSwan
+Quic
+verifier
+Quickstart
+Load
+RLOC
+Reass
+uri
+alg
+resync
+pnat
+membulk
+uRPF
+vr
+proto
+pmc
+macip
+unthrottle
+liveness
+sa
+snat
+vss
+uncomment
+Rebase
+tmpfile
+url
+lt
+eid
+itr
+rlocs
+vip
+vips
+flowtable
+lcp
+rawhtml
+myhugosite
+www
+Redhat
+javascript
+Refactor
+Refactored
+subdirectory
+Responder
+shortcodes
+shortcode
+Roadmap
+Roto
+SCHED_RR
+hugo
+SRTP
+SRv
+SRv6
+Scapy
+Shamir
+Shrikant
+Slideshow
+Specialisations
+Srmpls
+Srv
+Stateful
+Strongswan
+Subnet
+Subnets
+Sw
+Syslog
+Systemd
+TLS
+TPv
+TRex
+Tahhan
+Tahr
+Templated
+Tenant
+Terabit
+Terraform
+Timebase
+Tollet
+Tracedump
+Tsou
+Tunnelling
+UDP
+Unformat
+Uninstall
+Uninstalling
+Unittest
+Urpf
+Usergroup
+Userspace
+VM
+VMs
+VMware
+VPP
+VPP
+VRF
+VRF
+Vagrantfile
+Vagrantfiles
+Valgrind
+Vbox
+Vhost
+Virtio
+Virtualization
+Vlib
+Vmxnet
+Vnet
+Vpp
+Vppinfra
+Vrrp
+Vswitch
+Vxlan
+Warnicke
+Webinar
+Wiki
+Wikipedia
+Wireguard
+Wireshark
+Wl
+Workstream
+XXX
+Xenial
+Xeon
+Xerus
+Xtensa
+Yaml
+Zhao
+aarch
+abf
+accelera
+acl
+acyclic
 addr
+adl
 admin
 af
-Agg
-Ajourn
 al
 alloc
+allocator
+allowlist
 amine
-Ananyev
-Anycast
+ansi
 api
-API
 apiTrace
 app
 apps
 arg
 args
 arp
-Arp
-µs
+arping
 async
+atomics
 auth
 autoconf
+autoconfig
+autoconfiguration
 autodetect
-Autogenerated
 automake
 autoreconf
 autotools
@@ -42,96 +620,128 @@ ba
 backend
 backends
 backtrace
-Backtrace
 backtracing
-Barach
 baseva
 bd
 behaviour
+bfd
+bift
+bigly
+bihash
 bihash
-Bihash
-BIHASH
-Bihashes
 binutils
 bitmask
 bitzero
+blackholing
+blake
 bms
+boolean
 bootup
-Brockners
+bsid
 bss
 bufferindex
+bufmon
 bugfixing
 buildingrst
 builtin
+builtinurl
 busybox
-BV
 bvi
 byteswap
+cPython
 cacheline
-Castelino
 ccache
 ccmake
 cdp
 ce
-Centos
 cfssl
 cisco
-Cisco
 cj
 classful
 cli
 clib
-Clib
 cmake
-Cmake
-CMakeLists
 cmd
-Colour
-Comms
 condvar
 conf
 config
-Config
 connectable
 contiv
-Contiv
 copwhitelist
 copwhtlistbase
-Coras
 coredump
+macswap
+datagrams
+plen
 coredumps
-Coredumps
+refcount
 corefile
 corefiles
+usecases
 corekeeper
 corelist
+fff
+middlebox
+backpressure
+ruleset
+lookups
+callees
+dstIP
+dstPortDefinition
+promisc
+netfilter
+multiprotocol
+pluggable
+eBPF
+libbpf
+hostname
+xffb
+lpc
+ec
+adjacencies
+neighbours
+pluggable
+lagrange
+reass
+lw
+desc
+dscp
+apis
+verboseness
+controlplane
+utilisation
+dsr
 coremask
 couldn
-Coverity
+mfib
+params
 cp
+ei
+det
 cpel
+decaps
+datapath
+daemontools
+daemonizing
+decapsulating
+decapsulated
 cpp
-CPPFLAGS
 cpu
-cPython
 crc
+syntaxes
+urpf
 crcs
 crt
 crypto
-Crypto
 cryptodev
-Cryptodev
 ctrl
 ctwo
 dataplane
-Dataplane
-Dataplanes
 datastructures
 dbg
 de
 debian
 debuggability
-Debuginfo
 decap
 decapsulation
 declutters
@@ -142,57 +752,59 @@ dep
 depN
 deselection
 dest
-Dest
 dev
 devbind
 df
 dhcp
+dhcp
 dhcpd
-Diffs
+dhcpserver
 dir
 dirN
 distclean
 distro
-Distro
 distros
 dlsym
 dns
 dnsmasq
 doesn
-Donley
 dont
 doxygen
-Doxygen
 dpdk
+dpkg
 dpo
+dport
 dryrun
-DS
 dslite
 dst
 dumpxml
-eal
 eBGP
-Eifel
+eal
 elog
 elogs
 elts
+emacs
+emerg
 enablement
 encap
 endian
 enic
 enp
+enqueue
+enqueued
 enqueueing
-Enqueueing
+enqueues
+enums
 eos
 epoll
-Erns
 etcd
 ethernet
 ethertype
 ethip
 eventfd
 evt
-Extranets
+executables
+extensibility
 failover
 fallback
 favour
@@ -200,13 +812,12 @@ favoured
 favours
 fd
 fdioDocs
-FiB
 fifo
 fifos
 filesystem
+flavours
 flowendns
 flowprobe
-Flowprobe
 flowstartns
 fn
 foo
@@ -214,28 +825,63 @@ fooA
 fooB
 fooC
 foreach
-Gbe
-GbE
 gbit
-Gbits
+responder
+cryptographic
+tabula
+srv
+nsh
+xc
 gbp
-Gbps
-GByte
-Gbytes
 gcc
 gcov
+lxd
+testbed
+https
+configs
+zfs
+workspaces
+mss
+oddbuf
+srtp
+svs
+tlspicotls
+picotls
+respondhost
+initiatehost
+eth
+pem
+dhcpv
+subnet
+debootstrap
+sharepoint
+deps
 gdb
 ge
 gerrit
-Gerrit
 gettingsources
 gid
-Gigabit
-GigE
-Github
+marvell
+lldp
+geneve
+openssl
+ipsecmb
+cnat
+xdp
+runtime
+ikev
+ioam
+http
+hs
+runtime
+DoS
+chachapoly
 glibc
 gmake
-Goncalves
+libc
+tracedump
+urpf
+wireguard
 gpe
 gre
 grep
@@ -245,37 +891,33 @@ gso
 gtpu
 gud
 gui
-Gzip
 hairpinning
 handoff
 handoffs
+hashtable
 hdr
 heapsize
-Heapsize
-hostnames
 hostNetwork
+hostnames
 hoststack
 hotkey
-Hotkeys
 hpp
 hqos
-HQoS
 hsa
 html
 htop
-Huawei
 hugepage
 hugepages
 hugetlb
 hw
 hyperlink
 hypervisor
-Hypervisors
-ia
-iacl
-iAcl
 iACL
+iAcl
 iBGP
+iOAM
+ia
+iacl
 ibverb
 icmp
 ifndef
@@ -288,7 +930,6 @@ indices
 indicies
 ing
 init
-Init
 inline
 inlines
 intel
@@ -296,29 +937,23 @@ internet
 interworkings
 intfc
 io
-iOAM
 iommu
 ip
-IP
+ipN
+ipX
 ipaddress
 iperf
-Iperf
 ipfix
 ipip
-ipN
 ipsec
-IPsec
 iptables
 ipv
-IPv
-ipX
 isc
 isra
 itf
 ith
 ixgbe
 ixge
-Jira
 jsmith
 jsmithuser
 json
@@ -329,24 +964,17 @@ keepalives
 keychain
 kflows
 kni
-KOC
-Konstantynowicz
 ksr
 kube
-Kube
 kubeadm
-Kubeadm
 kubectl
 kubelet
-Kubelet
 kubeproxy
 kubernetes
-Kubernetes
 kv
 labelled
 lacp
 ld
-LDFLAGS
 ldp
 learnt
 len
@@ -357,125 +985,92 @@ libvirt
 linting
 linux
 linuxapp
-Linuxcon
 localhost
 localsid
-Lockless
 longjmp
 loopback
-Loopback
 lshw
 lstack
 lua
-Lua
-Luajit
 lxc
-Maciek
+mFIB
+mIn
 mactime
 mainp
 malloc
-Manohar
-Maryam
 maximise
 mb
 mbedtls
 mbit
 mbufs
-Mbytes
 mc
 md
 mem
 memfd
 memif
-Memif
 metadata
-Metadata
 mf
-mFIB
 mheap
-mIn
 mispositions
 misprograms
 mk
 mldv
 modelled
 modernisation
-Monroy
 mortem
 mpls
-MPLS
 mpps
-Mpps
 msg
 mtrie
 mtu
 multiarch
 multicast
-Multicast
-Multihoming
 multipath
 multiqueue
-Multiqueue
-Multistream
-Multitenancy
 mutex
-Mutlithreading
 myapp
 mygcc
 myplugin
+nBackingPages
+nBytes
 namespace
-Namespace
 namespaces
 nat
 nats
 natted
-nBackingPages
 nbytes
-nBytes
 ndrpdr
-Neighbour
 netcfg
-Netmap
+netlink
+netmap
 netplan
-Netplan
 nginx
-NIC
 nitems
 nn
 nnn
 nodaemon
 ns
 nsim
-Nstrings
 nullptr
 num
 numa
-NUMA
 oacl
 oam
-O'Driscoll
 offline
 ofr
 online
 ooo
-Openssl
 openSUSE
-Optimisations
 os
 packagecloud
 passthrough
 passwordless
 pcap
-Pcap
 pci
-PCI
 pe
 perf
 perfmon
-Perfmon
-Performan
 perror
-Pfister
 pfSense
 phoneycomponent
 physmem
@@ -484,15 +1079,10 @@ pidfile
 pifi
 pktgen
 plugin
-Plugin
 plugins
-Plugins
 pmalloc
-PoC
 podSubnet
 policer
-Policers
-Pollable
 poweroff
 pppoe
 pre
@@ -513,51 +1103,42 @@ pushingapatch
 py
 pypi
 qemu
-Qemu
 qos
-QoS
 qs
 qsz
 quic
-Quic
 quicly
 rasa
 rbtree
 rc
 rdma
+reStructured
+reStructuredText
 realcomponent
 realisation
 realise
 realsource
 rebase
-Rebase
 recognised
-Redhat
 refactor
-Refactor
 refactored
-Refactored
 regex
 reinjected
 repo
 repos
 restack
-reStructured
-reStructuredText
 rfc
 rint
-RLOC
-Roadmap
-Roto
 rpath
 rsa
 rst
 rwlocks
 rx
+sN
 sbin
+scalable
 scanf
 scapy
-Scapy
 sclass
 scooby
 screenshot
@@ -570,30 +1151,23 @@ settingupenvironment
 sfr
 shg
 shm
-Shrikant
 signalling
 sixrd
 sizeable
 sl
-Slideshow
-sN
 snapshoot
 socketsvr
 socksvr
-Specialisations
 spinlocks
 sr
 src
-SRv
 sshd
 ssl
 stateful
-Stateful
 statseg
 stdin
 stl
 stn
-Strongswan
 struct
 su
 subfolder
@@ -603,26 +1177,17 @@ subinterfaces
 sudo
 svm
 sw
-Sw
 sysctl
 sysfs
 syslog
-Syslog
 systemd
-Systemd
 sz
-Tahhan
-Tahr
 tapcli
 tcp
 tcpcontrolbits
 teardown
 ted
-Templated
-Tenant
 tep
-Terabit
-Terraform
 threadLeave
 threadplacement
 tid
@@ -631,34 +1196,25 @@ tls
 tlsmbedtls
 tlsopenssl
 tmp
-Tollet
 toolchain
 toolchains
 tos
 tp
 tpv
-TPv
-TRex
-Tsou
 ttl
-Tunnelling
 tuntap
 twovppinstances
 tx
 txt
 ubuntu
 udp
-UDP
 uid
 uio
 un
 unformat
-Unformat
 unicast
 uninstall
-Uninstall
 uninstalled
-Uninstalling
 unix
 unrouteable
 unserialize
@@ -669,17 +1225,18 @@ upgradability
 upgradable
 usec
 usergroup
-Usergroup
 username
 userspace
-Userspace
 usr
 uu
+vHost
+vRouter
+vRouters
+vSwitch
+vSwitches
+vTEP
 va
-Vagrantfile
-Vagrantfiles
 vapi
-Vbox
 vcl
 ve
 vec
@@ -690,85 +1247,74 @@ vfctl
 vfio
 vft
 vhost
-vHost
-Vhost
 virsh
 virtio
-Virtio
+virtualchnl
 virtualenv
 virtualization
-Virtualization
 virtualized
 vl
 vlan
 vlib
-Vlib
 vlibapi
 vlibmemory
 vls
 vm
-VM
-VMs
 vmware
-VMware
 vmx
 vmxnet
-Vmxnet
 vnet
-Vnet
+ap
 vom
 vpe
 vpn
 vpp
-Vpp
-VPP
 vppapigen
 vppapitrace
 vppcapture
+bb
 vppctl
 vppinfra
-Vppinfra
 vpppinfra
 vpps
+crit
+eb
+ee
 vpptrace
-VRF
+vrf
 vrouter
-vRouter
+vrrp
+decrementing
 vswitch
-vSwitch
-Vswitch
 vswitches
-vTEP
 vxlan
-Vxlan
 walkthrough
-Warnicke
-Webinar
+dequeue
+dpd
+disp
 webpage
+substring
+decrypted
+decrypt
+deregister
+superset
 whitelist
 whitelisting
 whitelists
 wiki
-Wiki
-Wikipedia
+ietf
 wireshark
-Wireshark
-Wl
-Workstream
-xchain
-xconnect
-Xenial
-Xeon
-Xerus
 xFFFFFFFF
-Xtensa
 xTR
+xchain
+xconnect
 xxx
-XXX
 xyz
 yaml
-Yaml
 yyy
-Zhao
 zoomin
 zoomout
+µs
+e.g.
+i.e.
+operationalize
\ No newline at end of file