projects / mirror_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. | |
| 44 | ||
| 45 | First Steps | |
| 46 | ----------- | |
| 47 | ||
| 795752a3 SF |
48 | Getting started with Open vSwitch (OVS) or Open Virtual Network (OVN) for Open |
| 49 | vSwitch? Start here. | |
| 50 | ||
| 51 | - **Install:** :doc:`intro/install/general` | | |
| 52 | :doc:`intro/install/userspace` | | |
| 53 | :doc:`intro/install/netbsd` | | |
| 54 | :doc:`intro/install/windows` | | |
| 55 | :doc:`intro/install/xenserver` | | |
| 56 | :doc:`intro/install/dpdk` | |
| 57 | ||
| e12569bb SF |
58 | - **Tutorials:** :doc:`tutorials/ovs-advanced` | |
| 59 | :doc:`tutorials/ovn-basics` | |
| 11820a1f SF |
60 | |
| 61 | Deeper Dive | |
| 62 | ----------- | |
| 63 | ||
| daf5079e | 64 | **TODO** |
| 11820a1f SF |
65 | |
| 66 | The Open vSwitch Project | |
| 67 | ------------------------ | |
| 68 | ||
| 69 | Learn more about the Open vSwitch project and about how you can contribute: | |
| 70 | ||
| d0e53b15 SF |
71 | - **Community:** :doc:`internals/release-process` | |
| 72 | :doc:`internals/authors` | | |
| 73 | :doc:`internals/mailing-lists` | | |
| 74 | :doc:`internals/bugs` | | |
| 75 | :doc:`internals/security` | |
| 76 | ||
| 77 | - **Contributing:** :doc:`internals/contributing/submitting-patches` | | |
| 78 | :doc:`internals/contributing/coding-style` | | |
| 79 | :doc:`internals/contributing/coding-style-windows` | |
| 80 | ||
| 81 | - **Maintaining:** :doc:`internals/maintainers` | | |
| 82 | :doc:`internals/committer-responsibilities` | | |
| 83 | :doc:`internals/committer-grant-revocation` | |
| 84 | ||
| 85 | - **Documentation:** :doc:`internals/contributing/documentation-style` | |
| 11820a1f SF |
86 | |
| 87 | Getting Help | |
| 88 | ------------- | |
| 89 | ||
| 90 | - Seeing an issue of potential bug? Report problems to bugs@openvswitch.org | |
| 91 | ||
| 92 | - Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or | |
| 93 | the :doc:`detailed table of contents <contents>`. |