Documentation/index.rst

   1 ..
   2       Copyright (c) 2016, Stephen Finucane <stephen@that.guru>
   3
   4       Licensed under the Apache License, Version 2.0 (the "License"); you may
   5       not use this file except in compliance with the License. You may obtain
   6       a copy of the License at
   7
   8           http://www.apache.org/licenses/LICENSE-2.0
   9
  10       Unless required by applicable law or agreed to in writing, software
  11       distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  12       WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  13       License for the specific language governing permissions and limitations
  14       under the License.
  15
  16       Convention for heading levels in Open vSwitch documentation:
  17
  18       =======  Heading 0 (reserved for the title in a document)
  19       -------  Heading 1
  20       ~~~~~~~  Heading 2
  21       +++++++  Heading 3
  22       '''''''  Heading 4
  23
  24       Avoid deeper levels because they do not render well.
  25
  26 ==========================
  27 Open vSwitch Documentation
  28 ==========================
  29
  30 How the Documentation is Organised
  31 ----------------------------------
  32
  33 The Open vSwitch documentation is organised into multiple sections:
  34
  35 - :doc:`Installation guides </intro/install/index>` guide you through
  36   installing Open vSwitch (OVS) and Open Virtual Network (OVN) on a variety of
  37   different platforms
  38 - :doc:`Tutorials </tutorials/index>` take you through a series of steps to
  39   configure OVS and OVN in sandboxed environments
  40 - :doc:`Topic guides </topics/index>` provide a high level overview of OVS and
  41   OVN internals and operation
  42 - :doc:`How-to guides </howto/index>` are recipes or use-cases for OVS and OVN.
  43   They are more advanced than the tutorials.
  44 - :doc:`Frequently Asked Questions </faq/index>` provide general insight into
  45   a variety of topics related to configuration and operation of OVS and OVN.
  46
  47 First Steps
  48 -----------
  49
  50 Getting started with Open vSwitch (OVS) or Open Virtual Network (OVN) for Open
  51 vSwitch? Start here.
  52
  53 - **Overview:** :doc:`intro/what-is-ovs` |
  54   :doc:`intro/why-ovs`
  55
  56 - **Install:** :doc:`intro/install/general` |
  57   :doc:`intro/install/userspace` |
  58   :doc:`intro/install/netbsd` |
  59   :doc:`intro/install/windows` |
  60   :doc:`intro/install/xenserver` |
  61   :doc:`intro/install/dpdk`
  62
  63 - **Tutorials:** :doc:`tutorials/ovs-advanced` |
  64
  65 Deeper Dive
  66 -----------
  67
  68 - **Architecture** :doc:`topics/design` |
  69   :doc:`topics/openflow` |
  70   :doc:`topics/integration` |
  71   :doc:`topics/porting`
  72
  73 - **DPDK** :doc:`howto/dpdk` |
  74   :doc:`topics/dpdk/vhost-user`
  75
  76 - **Windows** :doc:`topics/windows`
  77
  78 - **Integrations:** :doc:`topics/language-bindings`
  79
  80 - **Reference Guides:** :doc:`ref/index`
  81
  82 - **Testing** :doc:`topics/testing`
  83
  84 - **Packaging:** :doc:`intro/install/debian` |
  85   :doc:`intro/install/rhel` |
  86   :doc:`intro/install/fedora`
  87
  88 The Open vSwitch Project
  89 ------------------------
  90
  91 Learn more about the Open vSwitch project and about how you can contribute:
  92
  93 - **Community:** :doc:`internals/release-process` |
  94   :doc:`internals/authors` |
  95   :doc:`internals/mailing-lists` |
  96   :doc:`internals/patchwork` |
  97   :doc:`internals/bugs` |
  98   :doc:`internals/security`
  99
 100 - **Contributing:** :doc:`internals/contributing/submitting-patches` |
 101   :doc:`internals/contributing/coding-style` |
 102   :doc:`internals/contributing/coding-style-windows`
 103
 104 - **Maintaining:** :doc:`internals/maintainers` |
 105   :doc:`internals/committer-responsibilities` |
 106   :doc:`internals/committer-grant-revocation`
 107
 108 - **Documentation:** :doc:`internals/contributing/documentation-style` |
 109   :doc:`Building Open vSwitch Documentation <intro/install/documentation>`
 110
 111 Getting Help
 112 -------------
 113
 114 - Seeing an issue of potential bug? Report problems to bugs@openvswitch.org
 115
 116 - Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or
 117   the :doc:`detailed table of contents <contents>`.