Documentation/tutorials/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 Tutorials
  28 =========
  29
  30 Getting started with Open vSwitch (OVS) and Open Virtual Network (OVN) for Open
  31 vSwitch.
  32
  33 .. TODO(stephenfin): We could really do with a few basic tutorials, along with
  34    some more specialized ones (DPDK, XenServer, Windows). The latter could
  35    probably be formed from the install guides, but the former will need to be
  36    produced from scratch or reproduced from blogs (with permission of the
  37    author)
  38
  39 .. toctree::
  40    :maxdepth: 2
  41
  42    ovs-advanced