]>
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 | ||
e69e4f5b SF |
64 | - **Architecture** :doc:`topics/design` | |
65 | :doc:`topics/openflow` | | |
66 | :doc:`topics/integration` | | |
67 | :doc:`topics/porting` | |
68 | ||
69 | - **DPDK** :doc:`howto/dpdk` | | |
70 | :doc:`topics/dpdk/vhost-user` | | |
71 | :doc:`topics/dpdk/ivshmem` | |
72 | ||
73 | - **Windows** :doc:`topics/windows` | |
74 | ||
75 | - **Testing** :doc:`topics/testing` | |
76 | ||
4c624406 | 77 | - **Reference Guides:** :doc:`ref/index` |
11820a1f | 78 | |
73c76b44 SF |
79 | - **Packaging:** :doc:`intro/install/debian` | |
80 | :doc:`intro/install/rhel` | | |
81 | :doc:`intro/install/fedora` | |
82 | ||
11820a1f SF |
83 | The Open vSwitch Project |
84 | ------------------------ | |
85 | ||
86 | Learn more about the Open vSwitch project and about how you can contribute: | |
87 | ||
d0e53b15 SF |
88 | - **Community:** :doc:`internals/release-process` | |
89 | :doc:`internals/authors` | | |
90 | :doc:`internals/mailing-lists` | | |
3c2604f7 | 91 | :doc:`internals/patchwork` | |
d0e53b15 SF |
92 | :doc:`internals/bugs` | |
93 | :doc:`internals/security` | |
94 | ||
95 | - **Contributing:** :doc:`internals/contributing/submitting-patches` | | |
96 | :doc:`internals/contributing/coding-style` | | |
97 | :doc:`internals/contributing/coding-style-windows` | |
98 | ||
99 | - **Maintaining:** :doc:`internals/maintainers` | | |
100 | :doc:`internals/committer-responsibilities` | | |
101 | :doc:`internals/committer-grant-revocation` | |
102 | ||
73c76b44 SF |
103 | - **Documentation:** :doc:`internals/contributing/documentation-style` | |
104 | :doc:`Building Open vSwitch Documentation <intro/install/documentation>` | |
11820a1f SF |
105 | |
106 | Getting Help | |
107 | ------------- | |
108 | ||
109 | - Seeing an issue of potential bug? Report problems to bugs@openvswitch.org | |
110 | ||
111 | - Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or | |
112 | the :doc:`detailed table of contents <contents>`. |