summaryrefslogtreecommitdiff
path: root/Documentation/tutorials
diff options
context:
space:
mode:
authorStephen Finucane <stephen@that.guru>2016-12-08 12:55:21 +0000
committerBen Pfaff <blp@ovn.org>2016-12-12 08:52:36 -0800
commit11820a1fc00b655901f08003cf26ea1a93f43780 (patch)
treefceb10a71639642288905479f090dda79bd8ca03 /Documentation/tutorials
parentdaf5079e73550f868f0f7ea7c296d395eaff77ad (diff)
downloadopenvswitch-11820a1fc00b655901f08003cf26ea1a93f43780.tar.gz
doc: Create directory structure
Create a series of sections, all of which are currently empty, using the general design established by Jacob Kaplan-Moss and the Django project [1]. Five sections are provided: - intro - tutorials - topics - howto - ref - faq - internals The purpose of each section is described in the documents themselves. [1] https://jacobian.org/writing/great-documentation/ Signed-off-by: Stephen Finucane <stephen@that.guru> Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/tutorials')
-rw-r--r--Documentation/tutorials/index.rst34
1 files changed, 34 insertions, 0 deletions
diff --git a/Documentation/tutorials/index.rst b/Documentation/tutorials/index.rst
new file mode 100644
index 000000000..eebd24271
--- /dev/null
+++ b/Documentation/tutorials/index.rst
@@ -0,0 +1,34 @@
+..
+ 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.
+
+=========
+Tutorials
+=========
+
+Getting started with Open vSwitch (OVS) and Open Virtual Network (OVN) for Open
+vSwitch.
+
+.. toctree::
+ :maxdepth: 2