The Open vSwitch documentation is organised into multiple sections:
- :doc:`Installation guides </intro/install/index>` guide you through installing Open vSwitch (OVS) and Open Virtual Network (OVN) on a variety of different platforms
- :doc:`Tutorials </tutorials/index>` take you through a series of steps to configure OVS and OVN in sandboxed environments
- :doc:`Topic guides </topics/index>` provide a high level overview of OVS and OVN internals and operation
- :doc:`How-to guides </howto/index>` are recipes or use-cases for OVS and OVN. They are more advanced than the tutorials.
- :doc:`Frequently Asked Questions </faq/index>` provide general insight into a variety of topics related to configuration and operation of OVS and OVN.
Getting started with Open vSwitch (OVS) or Open Virtual Network (OVN) for Open vSwitch? Start here.
- Overview: :doc:`intro/what-is-ovs` | :doc:`intro/why-ovs`
- Install: :doc:`intro/install/general` | :doc:`intro/install/userspace` | :doc:`intro/install/netbsd` | :doc:`intro/install/windows` | :doc:`intro/install/xenserver` | :doc:`intro/install/dpdk` | :doc:`Installation FAQs <faq/releases>`
- Tutorials: :doc:`tutorials/faucet` | :doc:`tutorials/ovs-advanced` | :doc:`tutorials/ovn-sandbox` | :doc:`tutorials/ovn-openstack` | :doc:`tutorials/ovs-conntrack` | :doc:`tutorials/ipsec` | :doc:`tutorials/ovn-ipsec` | :doc:`tutorials/ovn-rbac`
- Architecture :doc:`topics/design` | :doc:`topics/openflow` | :doc:`topics/integration` | :doc:`topics/porting`
- DPDK :doc:`howto/dpdk` | :doc:`topics/dpdk/vhost-user`
- Windows :doc:`topics/windows`
- Integrations: :doc:`topics/language-bindings`
- Reference Guides: :doc:`ref/index`
- Testing :doc:`topics/testing`
- Packaging: :doc:`intro/install/debian` | :doc:`intro/install/rhel` | :doc:`intro/install/fedora`
Learn more about the Open vSwitch project and about how you can contribute:
- Community: :doc:`internals/release-process` | :doc:`internals/authors` | :doc:`internals/mailing-lists` | :doc:`internals/patchwork` | :doc:`internals/bugs` | :doc:`internals/security`
- Contributing: :doc:`internals/contributing/submitting-patches` | :doc:`internals/contributing/backporting-patches` | :doc:`internals/contributing/coding-style` | :doc:`internals/contributing/coding-style-windows`
- Maintaining: :doc:`internals/charter` | :doc:`internals/maintainers` | :doc:`internals/committer-responsibilities` | :doc:`internals/committer-grant-revocation` | :doc:`internals/committer-emeritus-status`
- Documentation: :doc:`internals/contributing/documentation-style` | :doc:`Building Open vSwitch Documentation <intro/install/documentation>` | :doc:`internals/documentation`
- Seeing an issue of potential bug? Report problems to [email protected]
- Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or the :doc:`detailed table of contents <contents>`.