summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Luke <chrisy@flirble.org>2016-09-14 12:42:54 -0400
committerChris Luke <chris_luke@comcast.com>2016-09-14 18:03:31 +0000
commit0f53393c82c8c21f6977749e1e9501232fcf8371 (patch)
tree7c8e955e9759dd62006c2703cf17776aa63a0977
parent1a30f381925192ef68c7377a6c2168f8f60eb33e (diff)
Add structure to some of the documentation; VPP-223
Moves the random .md files into a config examples tree Change-Id: If423b82f1047f1c84f90876a786313054b5f7c77 Signed-off-by: Chris Luke <chrisy@flirble.org>
-rw-r--r--README.md3
-rw-r--r--doxygen/Makefile1
-rw-r--r--doxygen/user_doc.md10
-rw-r--r--plugins/ioam-plugin/ioam/ioam_plugin_doc.md (renamed from plugins/ioam-plugin/ioam/Readme.md)3
-rw-r--r--plugins/lb-plugin/lb_plugin_doc.md (renamed from plugins/lb-plugin/README.md)2
-rw-r--r--vnet/vnet/ipsec-gre/ipsec_gre_doc.md2
-rw-r--r--vnet/vnet/map/map_doc.md2
7 files changed, 18 insertions, 5 deletions
diff --git a/README.md b/README.md
index ccc832c45d5..cfdb7a68ee2 100644
--- a/README.md
+++ b/README.md
@@ -90,5 +90,8 @@ for this can be found [on the Setting up Vagrant wiki page]
## More information.
+Several modules provide documentation, see @subpage user_doc for more
+information.
+
Visit the [VPP wiki](https://wiki.fd.io/view/VPP) for details on more
advanced building strategies and development notes.
diff --git a/doxygen/Makefile b/doxygen/Makefile
index f62fa7661ab..aa50e585eed 100644
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -31,6 +31,7 @@ DOXY_DIR ?= $(WS_ROOT)/doxygen
# Input directories and files
DOXY_INPUT ?= \
README.md \
+ doxygen/user_doc.md \
vppinfra \
svm \
vlib \
diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md
new file mode 100644
index 00000000000..d0e6380c66d
--- /dev/null
+++ b/doxygen/user_doc.md
@@ -0,0 +1,10 @@
+User Configuration Examples {#user_doc}
+===========================
+
+Several modules provide operational documentation.
+
+- @subpage ipsec_gre_doc
+- @subpage map_doc
+- @subpage ioam_plugin_doc
+- @subpage lb_plugin_doc
+
diff --git a/plugins/ioam-plugin/ioam/Readme.md b/plugins/ioam-plugin/ioam/ioam_plugin_doc.md
index 2c2d85573a9..071e1f061ee 100644
--- a/plugins/ioam-plugin/ioam/Readme.md
+++ b/plugins/ioam-plugin/ioam/ioam_plugin_doc.md
@@ -1,5 +1,4 @@
-
-## VPP Inband OAM (iOAM)
+## VPP Inband OAM (iOAM) {#ioam_plugin_doc}
In-band OAM (iOAM) is an implementation study to record operational
information in the packet while the packet traverses a path between
diff --git a/plugins/lb-plugin/README.md b/plugins/lb-plugin/lb_plugin_doc.md
index 4effe533cba..c7885ffb837 100644
--- a/plugins/lb-plugin/README.md
+++ b/plugins/lb-plugin/lb_plugin_doc.md
@@ -1,4 +1,4 @@
-# Load Balancer plugin for VPP
+# Load Balancer plugin for VPP {#lb_plugin_doc}
## Version
diff --git a/vnet/vnet/ipsec-gre/ipsec_gre_doc.md b/vnet/vnet/ipsec-gre/ipsec_gre_doc.md
index e9e5fdd9929..e1bb9cdab1a 100644
--- a/vnet/vnet/ipsec-gre/ipsec_gre_doc.md
+++ b/vnet/vnet/ipsec-gre/ipsec_gre_doc.md
@@ -1,4 +1,4 @@
-# VPP L2-GRE over IPsec implementation
+# VPP L2-GRE over IPsec implementation {#ipsec_gre_doc}
This is a memo intended to contain documentation of the VPP L2-GRE over IPsec implementation.
Everything that is not directly obvious should come here.
diff --git a/vnet/vnet/map/map_doc.md b/vnet/vnet/map/map_doc.md
index 230c52dfafd..17f3c51174b 100644
--- a/vnet/vnet/map/map_doc.md
+++ b/vnet/vnet/map/map_doc.md
@@ -1,4 +1,4 @@
-# VPP MAP and Lw4o6 implementation
+# VPP MAP and Lw4o6 implementation {#map_doc}
This is a memo intended to contain documentation of the VPP MAP and Lw4o6 implementations.
Everything that is not directly obvious should come here.