Add structure to some of the documentation; VPP-223

Moves the random .md files, when rendered by Doxygen,
into a config examples tree. We may later flesh this
out into a more complete user documentation section.

Change-Id: If423b82f1047f1c84f90876a786313054b5f7c77
Signed-off-by: Chris Luke <chrisy@flirble.org>

diff --git a/README.md b/README.md
index ccc832c..bf26c9d 100644 (file)
--- a/README.md
+++ b/README.md
@@ -27,7 +27,7 @@ Directory name         | Description
      g2                | Event log visualization tool
      gmod              | perf related?
      perftool          | Performance tool
-     plugins           | VPP bundled plugins directory
+@ref plugins           | VPP bundled plugins directory
 @ref svm               | Shared virtual memory allocation library
      test              | Unit tests
 @ref vlib              | VPP application library source
@@ -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 954191e..0a69c2d 100644 (file)
--- a/doxygen/Makefile
+++ b/doxygen/Makefile
@@ -40,10 +40,14 @@ DOXY_SRC_DIRECTORIES = \
 
 # Input directories and files
 DOXY_INPUT ?= \
-       README.md \
+       $(wildcard $(WS_ROOT)/*.md) \
+       $(wildcard $(DOXY_DIR)/*.md) \
        $(DOXY_SRC_DIRECTORIES) \
        plugins
 
+# Strip leading workspace path from input names
+DOXY_INPUT := $(subst $(WS_ROOT)/,,$(DOXY_INPUT))
+
 # Files to exclude, from pre-Doxygen steps, eg because they're
 # selectively compiled.
 # Examples would be to exclude non-DPDK related sources when

diff --git a/doxygen/user_doc.md b/doxygen/user_doc.md
new file mode 100644 (file)
index 0000000..b08ac86
--- /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 lldp_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
similarity index 99%
rename from plugins/ioam-plugin/ioam/Readme.md
rename to plugins/ioam-plugin/ioam/ioam_plugin_doc.md
index 469a15a..343abcf 100644 (file)
--- 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
similarity index 99%
rename from plugins/lb-plugin/README.md
rename to plugins/lb-plugin/lb_plugin_doc.md
index 4effe53..c7885ff 100644 (file)
--- 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 e9e5fdd..e1bb9cd 100644 (file)
--- 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/lldp/lldp.md b/vnet/vnet/lldp/lldp_doc.md
similarity index 97%
rename from vnet/vnet/lldp/lldp.md
rename to vnet/vnet/lldp/lldp_doc.md
index 55de8f0..bac480a 100644 (file)
--- a/vnet/vnet/lldp/lldp.md
+++ b/vnet/vnet/lldp/lldp_doc.md
@@ -1,4 +1,4 @@
-# VPP Link Layer Discovery Protocol (LLDP) implementation
+# VPP Link Layer Discovery Protocol (LLDP) implementation    {#lldp_doc}
 
 This is a memo intended to contain documentation of the VPP LLDP 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 230c52d..17f3c51 100644 (file)
--- 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.