From a62647280565662987769ab8470c4cda6c0f315c Mon Sep 17 00:00:00 2001 From: Russell Bryant Date: Thu, 2 Feb 2017 02:02:34 -0500 Subject: [PATCH] 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 Acked-by: Ben Pfaff --- Documentation/howto/index.rst | 6 ++++++ Documentation/topics/index.rst | 23 ++++++++++++++++++----- 2 files changed, 24 insertions(+), 5 deletions(-) diff --git a/Documentation/howto/index.rst b/Documentation/howto/index.rst index 2d3730029d8..5859a33dc38 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 28ee04e738f..fd4241423c6 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) `__ + - `(html) `__ + - `(plain text) `__