diff options
| author | Stephen Finucane <stephen@that.guru> | 2016-12-08 12:55:21 +0000 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2016-12-12 08:52:36 -0800 |
| commit | 11820a1fc00b655901f08003cf26ea1a93f43780 (patch) | |
| tree | fceb10a71639642288905479f090dda79bd8ca03 /Documentation/index.rst | |
| parent | daf5079e73550f868f0f7ea7c296d395eaff77ad (diff) | |
| download | openvswitch-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/index.rst')
| -rw-r--r-- | Documentation/index.rst | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst index 5e9c63d25..ee42acdf7 100644 --- a/Documentation/index.rst +++ b/Documentation/index.rst @@ -1,4 +1,6 @@ .. + 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 @@ -25,4 +27,42 @@ Open vSwitch Documentation ========================== +How the Documentation is Organised +---------------------------------- + +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. + +First Steps +----------- + +**TODO** + +Deeper Dive +----------- + **TODO** + +The Open vSwitch Project +------------------------ + +Learn more about the Open vSwitch project and about how you can contribute: + +**TODO** + +Getting Help +------------- + +- Seeing an issue of potential bug? Report problems to bugs@openvswitch.org + +- Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or + the :doc:`detailed table of contents <contents>`. |