16 Commits

Author SHA1 Message Date
Bence Romsics
c2fa5a8c57 vat2: docs
Add a bit of documentation for vat2 - mostly through examples.

Type: docs
Change-Id: I1a95047b2bd33522f562c9c1a6a7e9e639ab1a47
Signed-off-by: Bence Romsics <bence.romsics@gmail.com>
2024-11-27 02:52:26 +00:00
Matthew Giassa
4a0dd383cf docs: add VPP Container Testbench example and lab
Adding a "VPP container testbench" (pair of Docker containers plus
helper scripts to test Linux and VPP interfaces). Will be part of a
larger set of labs/exercises/tutorials. Putting this baseline setup up
for review first to see if the community sees use/value in it. If so,
additional exercises using the testbench will be added gradually.

Type: improvement
Signed-off-by: Matthew Giassa <mgiassa@cisco.com>
Change-Id: I582310f7355419e907d575f640482ca49cbb282f
2021-12-01 18:41:20 +00:00
Nathan Skrzypczak
cbb4e460c4 docs: C & C++ apis examples
Type: docs

Change-Id: I5b6c388332bdd3a29777d728c3357816c8411ea2
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
2021-10-13 23:22:32 +00:00
Nathan Skrzypczak
9ad39c026c 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>
2021-10-13 23:22:32 +00:00
Dave Barach
3db2c670a1 docs: cleanup, remove stale material
Point https://fd.io/docs/vpp/master/links/index.html at docs.fd.io/vpp
instead of at one specific stale release

Remove https://fd.io/docs/vpp/master/featuresbyrelease/index.html

Remove https://fd.io/docs/vpp/master/events/index.html

Remove dead projects from
https://fd.io/docs/vpp/master/relatedprojects/index.html

Remove unsupported distros from
https://fd.io/docs/vpp/master/whatisvpp/supported.html

Reduce (doxygen) list of test framework doc files to actively
supported releases

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: I179966fbbe09ac123e5f2647787a8dea93190b5c
2021-06-11 11:50:09 +00:00
John DeNisco
742000af20 docs: Reflect the fact that the DPDK is now a plugin
Type: Improvement

Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ic1253f601ee515392902a21b92e1dfd3962cc0a4
2020-07-06 12:30:31 -04:00
John DeNisco
c96d618a5d docs: Rewrite the what is VPP (first) section, also fix the build
Signed-off-by: John DeNisco <jdenisco@cisco.com>
Change-Id: Ifb558171f8976a721703e74afea997d006273b5f
Signed-off-by: Dave Barach <dave@barachs.net>
2019-11-06 16:15:49 -05:00
Dave Barach
56f62afe63 docs: grammar police raid
Edit the front-page intro text. Fix egregious grammar errors,
including an "it's" vs. "its" blunder.

Type: docs

Signed-off-by: Dave Barach <dave@barachs.net>
Change-Id: If9d7d07899c402cd49bbae988110a15216035b02
2019-10-07 13:20:41 +00:00
jdenisco
3bfeff7a98 docs: Fix Versions and Titles
Change-Id: I131e33a570bff8b22c767585d03e2eb281dd7184
Signed-off-by: jdenisco <jdenisco@cisco.com>
2019-05-17 20:31:10 +00:00
jdenisco
65ed2d0503 docs: Add version and build date
Change-Id: I6fd53d3ef12e4b6f1af1e5605c09938bce324ec9
Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-11-06 18:21:10 +00:00
jdenisco
45e1cd92ca docs: Added Related Projects and Archive
Change-Id: I9a6076aa53d810ec44761d9f9459eb91f2c05974
Signed-off-by: jdenisco <jdenisco@cisco.com>
2018-09-18 21:03:06 +00:00
Scitt Keeler
d9b2fcebef docs: Add features by release section
Change-Id: Ibcae8c8ecdf8a3c2d7bcf96bf7cd5b741e2fad22
Signed-off-by: Scitt Keeler <skeeler@cisco.com>
2018-08-30 18:45:51 +00:00
John DeNisco
a5db42f366 docs: Moved installing up a level, removed guides.
Change-Id: Ie4b2939b693698585f1f2d12391a0009e80bac0b
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-17 19:40:10 +00:00
John DeNisco
ce96dda447 DOCS: Moved multiarch and build system, Incorprated Scott's changes
Change-Id: I5a57846db2d4faac1aa24db4629b612657f59afb
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-14 20:13:21 +00:00
John DeNisco
758dc46072 DOCS: Cleanup Getting Started
Change-Id: I4766773779f8d5c30a24bfed48090d7305c80ec5
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-08-13 17:00:22 -04:00
John DeNisco
06dcd45ff8 Initial commit of Sphinx docs
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77
Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 18:34:47 +00:00