ligang/vpp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
vpp/docs/aboutvpp/supported.rst

29 lines
432 B
ReStructuredText
Raw Normal View History

Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 12:45:10 -04:00
.. _supported:
.. toctree::
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-08-19 11:38:06 +02:00
Supported archs and OS
**********************
Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 12:45:10 -04:00
docs: what is vpp and features and performance Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46 Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-09-06 07:52:59 -04:00
The following architectures and operating systems are supported in VPP:
Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 12:45:10 -04:00
Architectures
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-08-19 11:38:06 +02:00
-------------
Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 12:45:10 -04:00
docs: what is vpp and features and performance Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46 Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-09-06 07:52:59 -04:00
* The FD.io VPP platform supports:
Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 12:45:10 -04:00
docs: what is vpp and features and performance Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46 Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-09-06 07:52:59 -04:00
* x86/64
* ARM-AArch64
Update AArch64 CSIT machines into FD.io VPP docs The outlook will appear as below. The FD.io CSIT is implemented with below platforms: x86/64 ARM-AArch64 Huawei TaiShan 2280 Marvell MACCHIATObin Change-Id: Ie84a99c53a0fc2186ea6992baca9558b6d96c7f8 Signed-off-by: Lijian Zhang <Lijian.Zhang@arm.com>
2018-08-07 15:34:45 +08:00
Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 12:45:10 -04:00
Operating Systems and Packaging
-------------------------------
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-09 07:49:34 -04:00
FD.io VPP supports package installation on the following
recent LTS releases:
Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 12:45:10 -04:00
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-09 07:49:34 -04:00
* Distributions:
Initial commit of Sphinx docs Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
2018-07-26 12:45:10 -04:00
docs: what is vpp and features and performance Change-Id: I5a9ae39ed0429b3de001b5109268d577a281cd46 Signed-off-by: Scott Keeler <skeeler@cisco.com>
2018-09-06 07:52:59 -04:00
* Debian
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-09 07:49:34 -04:00
* Ubuntu
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 10:58:28 -08:00
Reference in New Issue Copy Permalink