projects / ovs.git / blame
| Commit | Line | Data |
|---|---|---|
| daf5079e | 1 | .. |
| 11820a1f SF |
2 | Copyright (c) 2016, Stephen Finucane <stephen@that.guru> |
| 3 | ||
| daf5079e SF |
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 | ||
| 11820a1f SF |
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. | |
| c26ed9c2 JS |
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. | |
| 11820a1f SF |
46 | |
| 47 | First Steps | |
| 48 | ----------- | |
| 49 | ||
| 795752a3 SF |
50 | Getting started with Open vSwitch (OVS) or Open Virtual Network (OVN) for Open |
| 51 | vSwitch? Start here. | |
| 52 | ||
| 2eaf6a08 SF |
53 | - **Overview:** :doc:`intro/what-is-ovs` | |
| 54 | :doc:`intro/why-ovs` | |
| 55 | ||
| 795752a3 SF |
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` | | |
| 624f6206 SF |
61 | :doc:`intro/install/dpdk` | |
| 62 | :doc:`Installation FAQs <faq/releases>` | |
| 795752a3 | 63 | |
| e12569bb | 64 | - **Tutorials:** :doc:`tutorials/ovs-advanced` | |
| e5fb78af JS |
65 | :doc:`tutorials/ovn-sandbox` | |
| 66 | :doc:`tutorials/ovn-openstack` | |
| 11820a1f SF |
67 | |
| 68 | Deeper Dive | |
| 69 | ----------- | |
| 70 | ||
| e69e4f5b SF |
71 | - **Architecture** :doc:`topics/design` | |
| 72 | :doc:`topics/openflow` | | |
| 73 | :doc:`topics/integration` | | |
| 74 | :doc:`topics/porting` | |
| 75 | ||
| 76 | - **DPDK** :doc:`howto/dpdk` | | |
| 90ca71dd | 77 | :doc:`topics/dpdk/vhost-user` |
| e69e4f5b SF |
78 | |
| 79 | - **Windows** :doc:`topics/windows` | |
| 80 | ||
| f150a8ba | 81 | - **Integrations:** :doc:`topics/language-bindings` |
| e69e4f5b | 82 | |
| 4c624406 | 83 | - **Reference Guides:** :doc:`ref/index` |
| 11820a1f | 84 | |
| f150a8ba SF |
85 | - **Testing** :doc:`topics/testing` |
| 86 | ||
| 73c76b44 SF |
87 | - **Packaging:** :doc:`intro/install/debian` | |
| 88 | :doc:`intro/install/rhel` | | |
| 89 | :doc:`intro/install/fedora` | |
| 90 | ||
| 11820a1f SF |
91 | The Open vSwitch Project |
| 92 | ------------------------ | |
| 93 | ||
| 94 | Learn more about the Open vSwitch project and about how you can contribute: | |
| 95 | ||
| d0e53b15 SF |
96 | - **Community:** :doc:`internals/release-process` | |
| 97 | :doc:`internals/authors` | | |
| 98 | :doc:`internals/mailing-lists` | | |
| 3c2604f7 | 99 | :doc:`internals/patchwork` | |
| d0e53b15 SF |
100 | :doc:`internals/bugs` | |
| 101 | :doc:`internals/security` | |
| 102 | ||
| 103 | - **Contributing:** :doc:`internals/contributing/submitting-patches` | | |
| 1102cc39 | 104 | :doc:`internals/contributing/backporting-patches` | |
| d0e53b15 SF |
105 | :doc:`internals/contributing/coding-style` | |
| 106 | :doc:`internals/contributing/coding-style-windows` | |
| 107 | ||
| 108 | - **Maintaining:** :doc:`internals/maintainers` | | |
| 109 | :doc:`internals/committer-responsibilities` | | |
| 110 | :doc:`internals/committer-grant-revocation` | |
| 111 | ||
| 73c76b44 | 112 | - **Documentation:** :doc:`internals/contributing/documentation-style` | |
| 1e6567d4 SF |
113 | :doc:`Building Open vSwitch Documentation <intro/install/documentation>` | |
| 114 | :doc:`internals/documentation` | |
| 11820a1f SF |
115 | |
| 116 | Getting Help | |
| 117 | ------------- | |
| 118 | ||
| 119 | - Seeing an issue of potential bug? Report problems to bugs@openvswitch.org | |
| 120 | ||
| 121 | - Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or | |
| 122 | the :doc:`detailed table of contents <contents>`. |