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 /doxygen/user_doc.md | |
| 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 'doxygen/user_doc.md')
| -rw-r--r-- | doxygen/user_doc.md | 35 |
1 files changed, 0 insertions, 35 deletions
diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md deleted file mode 100644 index ff597c0421b..00000000000 --- a/doxygen/user_doc.md +++ /dev/null @@ -1,35 +0,0 @@ -User Documentation {#user_doc} -================== - -Several modules provide operational, dataplane-user focused documentation. - -- [GUI guided user demo](https://wiki.fd.io/view/VPP_Sandbox/vpp-userdemo) -- @subpage avf_plugin_doc -- @subpage bfd_doc -- @subpage dpdk_crypto_ipsec_doc -- @subpage dhcp6_pd_doc -- @subpage flowprobe_plugin_doc -- @subpage ioam_plugin_doc -- @subpage kp_plugin_doc -- @subpage lacp_plugin_doc -- @subpage lb_plugin_doc -- @subpage lldp_doc -- @subpage map_doc -- @subpage marvell_plugin_doc -- @subpage srv6_mobile_plugin -- @subpage mtu_doc -- @subpage nat64_doc -- @subpage nat_ha_doc -- @subpage qos_doc -- @subpage quic_doc -- @subpage rdma_doc -- @subpage selinux_doc -- @subpage span_doc -- @subpage srmpls_doc -- @subpage srv6_doc -- @subpage vcl_ldpreload_doc -- @subpage vmxnet3_doc -- @subpage af_xdp_doc -- @subpage wireguard_plugin_doc -- @subpage vpp_top_doc -- @subpage stats_fs_doc |