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) on a variety of different platforms
  37 - :doc:`Tutorials </tutorials/index>` take you through a series of steps to
  38   configure OVS in sandboxed environments
  39 - :doc:`Topic guides </topics/index>` provide a high level overview of OVS
  40   internals and operation
  41 - :doc:`How-to guides </howto/index>` are recipes or use-cases for OVS.
  42   They are more advanced than the tutorials.
  43 - :doc:`Frequently Asked Questions </faq/index>` provide general insight into
  44   a variety of topics related to configuration and operation of OVS.
  45
  46 First Steps
  47 -----------
  48
  49 Getting started with Open vSwitch (OVS)? Start here.
  50
  51 - **Overview:** :doc:`intro/what-is-ovs` |
  52   :doc:`intro/why-ovs`
  53
  54 - **Install:** :doc:`intro/install/general` |
  55   :doc:`intro/install/userspace` |
  56   :doc:`intro/install/netbsd` |
  57   :doc:`intro/install/windows` |
  58   :doc:`intro/install/xenserver` |
  59   :doc:`intro/install/dpdk` |
  60   :doc:`intro/install/afxdp` |
  61   :doc:`Installation FAQs <faq/releases>`
  62
  63 - **Tutorials:** :doc:`tutorials/faucet` |
  64   :doc:`tutorials/ovs-advanced` |
  65   :doc:`tutorials/ovs-conntrack` |
  66   :doc:`tutorials/ipsec` |
  67
  68 Deeper Dive
  69 -----------
  70
  71 - **Architecture** :doc:`topics/design` |
  72   :doc:`topics/openflow` |
  73   :doc:`topics/integration` |
  74   :doc:`topics/porting` |
  75   :doc:`topics/ovs-extensions`
  76
  77 - **DPDK** :doc:`howto/dpdk` |
  78   :doc:`topics/dpdk/vhost-user`
  79
  80 - **Windows** :doc:`topics/windows`
  81
  82 - **Integrations:** :doc:`topics/language-bindings`
  83
  84 - **Reference Guides:** :doc:`ref/index`
  85
  86 - **Testing** :doc:`topics/testing` :doc:`topics/fuzzing/index`
  87
  88 - **Packaging:** :doc:`intro/install/debian` |
  89   :doc:`intro/install/rhel` |
  90   :doc:`intro/install/fedora`
  91
  92 The Open vSwitch Project
  93 ------------------------
  94
  95 Learn more about the Open vSwitch project and about how you can contribute:
  96
  97 - **Community:** :doc:`internals/release-process` |
  98   :doc:`internals/authors` |
  99   :doc:`internals/mailing-lists` |
 100   :doc:`internals/patchwork` |
 101   :doc:`internals/bugs` |
 102   :doc:`internals/security`
 103
 104 - **Contributing:** :doc:`internals/contributing/submitting-patches` |
 105   :doc:`internals/contributing/backporting-patches` |
 106   :doc:`internals/contributing/coding-style` |
 107   :doc:`internals/contributing/coding-style-windows`
 108
 109 - **Maintaining:** :doc:`internals/charter` |
 110   :doc:`internals/maintainers` |
 111   :doc:`internals/committer-responsibilities` |
 112   :doc:`internals/committer-grant-revocation` |
 113   :doc:`internals/committer-emeritus-status`
 114
 115 - **Documentation:** :doc:`internals/contributing/documentation-style` |
 116   :doc:`Building Open vSwitch Documentation <intro/install/documentation>` |
 117   :doc:`internals/documentation`
 118
 119 Getting Help
 120 -------------
 121
 122 - Seeing an issue of potential bug? Report problems to bugs@openvswitch.org
 123
 124 - Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or
 125   the :doc:`detailed table of contents <contents>`.