Skip to content

Commit

Permalink
docs: Add OVS and OVN headings to pages.
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
russellb committed Feb 3, 2017
1 parent 2f35b6c commit a626472
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 5 deletions.
6 changes: 6 additions & 0 deletions Documentation/howto/index.rst
Expand Up @@ -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

Expand All @@ -46,6 +49,9 @@ topics covered herein, refer to :doc:`/topics/index`.
sflow
dpdk

OVN
---

.. toctree::
:maxdepth: 1

Expand Down
23 changes: 18 additions & 5 deletions Documentation/topics/index.rst
Expand Up @@ -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
Expand All @@ -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>`__

0 comments on commit a626472

Please sign in to comment.