File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 11EXTRA_DIST += \
22 Documentation/group-selection-method-property.txt \
33 Documentation/_static/logo.png \
4+ Documentation/_static/overview.png \
45 Documentation/conf.py \
56 Documentation/index.rst \
67 Documentation/contents.rst \
78 Documentation/intro/index.rst \
9+ Documentation/intro/what-is-ovs.rst \
810 Documentation/intro/why-ovs.rst \
911 Documentation/intro/install/index.rst \
1012 Documentation/intro/install/bash-completion.rst \
Original file line number Diff line number Diff line change @@ -48,6 +48,9 @@ First Steps
4848Getting started with Open vSwitch (OVS) or Open Virtual Network (OVN) for Open
4949vSwitch? Start here.
5050
51+ - **Overview: ** :doc: `intro/what-is-ovs ` |
52+ :doc: `intro/why-ovs `
53+
5154- **Install: ** :doc: `intro/install/general ` |
5255 :doc: `intro/install/userspace ` |
5356 :doc: `intro/install/netbsd ` |
Original file line number Diff line number Diff line change @@ -32,5 +32,6 @@ How to get started with Open vSwitch.
3232.. toctree ::
3333 :maxdepth: 2
3434
35+ what-is-ovs
3536 why-ovs
3637 install/index
Original file line number Diff line number Diff line change 1+ ..
2+ Copyright (c) 2016, Stephen Finucane <stephen@that.guru>
3+
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+ What Is Open vSwitch?
28+ =====================
29+
30+ .. image :: ../_static/overview.png
31+ :align: center
32+
33+ Overview
34+ --------
35+
36+ .. NOTE(stephenfin): The below line numbers may need to be updated if the
37+ README is modified
38+
39+ .. include :: ../../README.rst
40+ :start-line: 13
41+ :end-line: 71
Original file line number Diff line number Diff line change 1+ .. NOTE(stephenfin): If making changes to this file, ensure that the line
2+ numbers found in 'Documentation/intro/what-is-ovs' are kept up-to-date.
3+
14============
25Open vSwitch
36============
47
5- Build Status
6- ------------
7-
88.. image :: https://travis-ci.org/openvswitch/ovs.png
99 :target: https://travis-ci.org/openvswitch/ovs
1010
You can’t perform that action at this time.
0 commit comments