docs: Add OVS and OVN headings to pages.

Update the "deep dive" and "howto" pages with headings that more clearly indicate the separate lists of OVS or OVN content. Also add a link to ovn-architecture from the "deep dive" page as it seems quite relevant there. Signed-off-by: Russell Bryant <[email protected]> Acked-by: Ben Pfaff <[email protected]>
grizax · Feb 3, 2017 · a626472 · a626472
1 parent 2f35b6c
commit a626472
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 5 deletions.
diff --git a/Documentation/howto/index.rst b/Documentation/howto/index.rst
@@ -30,6 +30,9 @@ How-to Guides
 Answers to common "How do I?"-style questions. For more information on the
 topics covered herein, refer to :doc:`/topics/index`.
 
+OVS
+---
+
 .. toctree::
    :maxdepth: 2
 
@@ -46,6 +49,9 @@ topics covered herein, refer to :doc:`/topics/index`.
    sflow
    dpdk
 
+OVN
+---
+
 .. toctree::
    :maxdepth: 1
 

diff --git a/Documentation/topics/index.rst b/Documentation/topics/index.rst
@@ -23,12 +23,15 @@
 
       Avoid deeper levels because they do not render well.
 
-======================
-Open vSwitch Deep Dive
-======================
+=========
+Deep Dive
+=========
 
-How Open vSwitch is implemented and, where necessary, why it was implemented
-that way.
+How Open vSwitch and OVN are implemented and, where necessary, why it was
+implemented that way.
+
+OVS
+---
 
 .. toctree::
    :maxdepth: 2
@@ -45,7 +48,17 @@ that way.
    language-bindings
    testing
 
+OVN
+---
+
 .. toctree::
    :maxdepth: 2
 
    high-availability
+
+.. list-table::
+
+   * - ovn-architecture(7)
+     - `(pdf) <http://openvswitch.org/support/dist-docs/ovn-architecture.7.pdf>`__
+     - `(html) <http://openvswitch.org/support/dist-docs/ovn-architecture.7.html>`__
+     - `(plain text) <http://openvswitch.org/support/dist-docs/ovn-architecture.7.txt>`__