diff mbox

[ovs-dev] docs: Add OVS and OVN headings to pages.

Message ID 20170202070234.14750-1-russell@ovn.org
State Accepted
Headers show

Commit Message

Russell Bryant Feb. 2, 2017, 7:02 a.m. UTC
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 <russell@ovn.org>
---
 Documentation/howto/index.rst  |  6 ++++++
 Documentation/topics/index.rst | 23 ++++++++++++++++++-----
 2 files changed, 24 insertions(+), 5 deletions(-)

Comments

Ben Pfaff Feb. 2, 2017, 5:40 p.m. UTC | #1
On Thu, Feb 02, 2017 at 02:02:34AM -0500, Russell Bryant wrote:
> 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 <russell@ovn.org>

Acked-by: Ben Pfaff <blp@ovn.org>
Russell Bryant Feb. 3, 2017, 5:43 p.m. UTC | #2
On Thu, Feb 2, 2017 at 12:40 PM, Ben Pfaff <blp@ovn.org> wrote:

> On Thu, Feb 02, 2017 at 02:02:34AM -0500, Russell Bryant wrote:
> > 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 <russell@ovn.org>
>
> Acked-by: Ben Pfaff <blp@ovn.org>
>

Thanks, applied to master.
diff mbox

Patch

diff --git a/Documentation/howto/index.rst b/Documentation/howto/index.rst
index 2d37300..5859a33 100644
--- 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
index 28ee04e..fd42414 100644
--- 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>`__