2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 01:51:26 +00:00

doc: Add a 'what-is-ovs' document

Add description of Open vSwitch from README, along with the overview
image from openvswitch.org.

Signed-off-by: Stephen Finucane <stephen@that.guru>
Signed-off-by: Ben Pfaff <blp@ovn.org>
This commit is contained in:
Stephen Finucane 2016-12-22 09:54:45 +00:00 committed by Ben Pfaff
parent f150a8bafb
commit 2eaf6a0855
6 changed files with 50 additions and 3 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 198 KiB

View File

@ -1,10 +1,12 @@
EXTRA_DIST += \
Documentation/group-selection-method-property.txt \
Documentation/_static/logo.png \
Documentation/_static/overview.png \
Documentation/conf.py \
Documentation/index.rst \
Documentation/contents.rst \
Documentation/intro/index.rst \
Documentation/intro/what-is-ovs.rst \
Documentation/intro/why-ovs.rst \
Documentation/intro/install/index.rst \
Documentation/intro/install/bash-completion.rst \

View File

@ -48,6 +48,9 @@ First Steps
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` |

View File

@ -32,5 +32,6 @@ How to get started with Open vSwitch.
.. toctree::
:maxdepth: 2
what-is-ovs
why-ovs
install/index

View File

@ -0,0 +1,41 @@
..
Copyright (c) 2016, Stephen Finucane <stephen@that.guru>
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
License for the specific language governing permissions and limitations
under the License.
Convention for heading levels in Open vSwitch documentation:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
Avoid deeper levels because they do not render well.
=====================
What Is Open vSwitch?
=====================
.. image:: ../_static/overview.png
:align: center
Overview
--------
.. NOTE(stephenfin): The below line numbers may need to be updated if the
README is modified
.. include:: ../../README.rst
:start-line: 13
:end-line: 71

View File

@ -1,10 +1,10 @@
.. NOTE(stephenfin): If making changes to this file, ensure that the line
numbers found in 'Documentation/intro/what-is-ovs' are kept up-to-date.
============
Open vSwitch
============
Build Status
------------
.. image:: https://travis-ci.org/openvswitch/ovs.png
:target: https://travis-ci.org/openvswitch/ovs