diff options
| author | Stephen Finucane <stephen@that.guru> | 2016-12-22 09:54:45 +0000 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-12-22 10:15:51 -0800 |
| commit | 2eaf6a08559ac915da9e060ce0251ccfa9d97fcd (patch) | |
| tree | f913ae28476f616c9c50a7e26df2496f5490604f /Documentation | |
| parent | f150a8bafbf2ab7cc2e85f3c63ad443eb4f376eb (diff) | |
| download | openvswitch-2eaf6a08559ac915da9e060ce0251ccfa9d97fcd.tar.gz | |
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>
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/_static/overview.png | bin | 0 -> 203079 bytes | |||
| -rw-r--r-- | Documentation/automake.mk | 2 | ||||
| -rw-r--r-- | Documentation/index.rst | 3 | ||||
| -rw-r--r-- | Documentation/intro/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/intro/what-is-ovs.rst | 41 |
5 files changed, 47 insertions, 0 deletions
diff --git a/Documentation/_static/overview.png b/Documentation/_static/overview.png Binary files differnew file mode 100644 index 000000000..68948cf21 --- /dev/null +++ b/Documentation/_static/overview.png diff --git a/Documentation/automake.mk b/Documentation/automake.mk index b7b3cc1fa..98adca74d 100644 --- a/Documentation/automake.mk +++ b/Documentation/automake.mk @@ -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 \ diff --git a/Documentation/index.rst b/Documentation/index.rst index 5a925135f..e4e98cb29 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -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` | diff --git a/Documentation/intro/index.rst b/Documentation/intro/index.rst index 7ad8bf383..0ad7ad1dc 100644 --- a/Documentation/intro/index.rst +++ b/Documentation/intro/index.rst @@ -32,5 +32,6 @@ How to get started with Open vSwitch. .. toctree:: :maxdepth: 2 + what-is-ovs why-ovs install/index diff --git a/Documentation/intro/what-is-ovs.rst b/Documentation/intro/what-is-ovs.rst new file mode 100644 index 000000000..bf7071f7a --- /dev/null +++ b/Documentation/intro/what-is-ovs.rst @@ -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 |
