diff options
author | Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2021-08-19 11:38:06 +0200 |
---|---|---|
committer | Dave Wallace <dwallacelf@gmail.com> | 2021-10-13 23:22:32 +0000 |
commit | 9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160 (patch) | |
tree | 3cca19635417e28ae381d67ae31c75df2925032d /docs/whatisvpp/index.rst | |
parent | f47122e07e1ecd0151902a3cabe46c60a99bee8e (diff) |
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>
Diffstat (limited to 'docs/whatisvpp/index.rst')
-rw-r--r-- | docs/whatisvpp/index.rst | 37 |
1 files changed, 0 insertions, 37 deletions
diff --git a/docs/whatisvpp/index.rst b/docs/whatisvpp/index.rst deleted file mode 100644 index 464119ccad5..00000000000 --- a/docs/whatisvpp/index.rst +++ /dev/null @@ -1,37 +0,0 @@ -.. _whatisvpp: - -================================= -The Vector Packet Processor (VPP) -================================= - -This section describes some of the core concepts and features of FD.io VPP. - -To start with FD.io VPP uses a technique called Vector Packet Processing. -This gives FD.io VPP a siginficant performance improvement over packet -processing applications that use scalar processing. - -Also, At the heart of Fd.io VPP's modular design is a 'Packet Processing Graph'. -This makes FD.io VPP scalable and easily extensible. - -The FD.io software also includes a feature rich network stack. This includes -a TCP host stack that utilizes VPP’s graph based forwarding model and vectorized -packet processing. - -FD.io VPP is tested nightly for functionality and performance with the -CSIT project. - -For more information on any of these features click on the links below or -press next. - -.. toctree:: - :maxdepth: 1 - - scalar-vs-vector-packet-processing.rst - extensible.rst - networkstack.rst - hoststack.rst - developer.rst - supported.rst - performance.rst - -Press next for more about Scalar/Vector Packet processing. |