summaryrefslogtreecommitdiff
path: root/Documentation/index.rst
diff options
context:
space:
mode:
authorFlavio Leitner <fbl@sysclose.org>2020-12-28 19:02:55 -0300
committerBen Pfaff <blp@ovn.org>2021-01-07 12:13:33 -0800
commit7f79ae2fb677649e00868bf03b42fc81f7f293a3 (patch)
treea36bdd93816e515a4b82c0159646ad8e24c4d7a5 /Documentation/index.rst
parentfcf281b0b61078dc8ca23ebe1e2198c3f7c6763f (diff)
downloadopenvswitch-7f79ae2fb677649e00868bf03b42fc81f7f293a3.tar.gz
Documentation: Simplify the website main page.
The initial website page is difficult to read because of the large amount of links from different parts of the whole documentation. Most of all those links come from their index page referenced in the section 'Contents' on the side. Another issue is that because the page is static, new links might not get included. This patch simplifies the main page by highlighting the project level documentation. The static part is reduced to the main level index pages. All the links are available by clicking on 'Full Table of Contents' at the end of Documentation section. Signed-off-by: Flavio Leitner <fbl@sysclose.org> Signed-off-by: Ben Pfaff <blp@ovn.org>
Diffstat (limited to 'Documentation/index.rst')
-rw-r--r--Documentation/index.rst123
1 files changed, 38 insertions, 85 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 1f1da2916..3cdc87c69 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -23,103 +23,56 @@
Avoid deeper levels because they do not render well.
-==========================
-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) on a variety of different platforms
-- :doc:`Tutorials </tutorials/index>` take you through a series of steps to
- configure OVS in sandboxed environments
-- :doc:`Topic guides </topics/index>` provide a high level overview of OVS
- internals and operation
-- :doc:`How-to guides </howto/index>` are recipes or use-cases for OVS.
- They are more advanced than the tutorials.
-- :doc:`Frequently Asked Questions </faq/index>` provide general insight into
- a variety of topics related to configuration and operation of OVS.
-
-First Steps
------------
-
-Getting started with Open vSwitch (OVS)? 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` |
- :doc:`intro/install/windows` |
- :doc:`intro/install/xenserver` |
- :doc:`intro/install/dpdk` |
- :doc:`intro/install/afxdp` |
- :doc:`Installation FAQs <faq/releases>`
-
-- **Tutorials:** :doc:`tutorials/faucet` |
- :doc:`tutorials/ovs-advanced` |
- :doc:`tutorials/ovs-conntrack` |
- :doc:`tutorials/ipsec` |
-
-Deeper Dive
------------
-
-- **Architecture** :doc:`topics/design` |
- :doc:`topics/openflow` |
- :doc:`topics/integration` |
- :doc:`topics/porting` |
- :doc:`topics/ovs-extensions`
-
-- **DPDK** :doc:`howto/dpdk` |
- :doc:`topics/dpdk/vhost-user`
+=======
+Project
+=======
-- **Windows** :doc:`topics/windows`
+Community
+---------
-- **Integrations:** :doc:`topics/language-bindings`
+ - :doc:`internals/mailing-lists`
+ - :doc:`internals/bugs`
+ - :doc:`internals/patchwork`
+ - :doc:`internals/release-process`
+ - :doc:`internals/security`
+ - :doc:`internals/authors`
-- **Reference Guides:** :doc:`ref/index`
-- **Testing** :doc:`topics/testing` :doc:`topics/fuzzing/index`
+Contributing
+------------
-- **Packaging:** :doc:`intro/install/debian` |
- :doc:`intro/install/rhel` |
- :doc:`intro/install/fedora`
+ - :doc:`internals/contributing/submitting-patches`
+ - :doc:`internals/contributing/backporting-patches`
+ - :doc:`internals/contributing/coding-style`
+ - :doc:`internals/contributing/coding-style-windows`
-The Open vSwitch Project
-------------------------
-
-Learn more about the Open vSwitch project and about how you can contribute:
+Maintaining
+-----------
-- **Community:** :doc:`internals/release-process` |
- :doc:`internals/authors` |
- :doc:`internals/mailing-lists` |
- :doc:`internals/patchwork` |
- :doc:`internals/bugs` |
- :doc:`internals/security`
+ - :doc:`internals/charter`
+ - :doc:`internals/maintainers`
+ - :doc:`internals/committer-responsibilities`
+ - :doc:`internals/committer-grant-revocation`
+ - :doc:`internals/committer-emeritus-status`
-- **Contributing:** :doc:`internals/contributing/submitting-patches` |
- :doc:`internals/contributing/backporting-patches` |
- :doc:`internals/contributing/coding-style` |
- :doc:`internals/contributing/coding-style-windows`
+Documentation
+-------------
-- **Maintaining:** :doc:`internals/charter` |
- :doc:`internals/maintainers` |
- :doc:`internals/committer-responsibilities` |
- :doc:`internals/committer-grant-revocation` |
- :doc:`internals/committer-emeritus-status`
+ - :doc:`intro/index`
+ - :doc:`tutorials/index`
+ - :doc:`howto/index`
+ - :doc:`topics/index`
+ - :doc:`ref/index`
+ - :doc:`internals/index`
+ - :doc:`intro/install/documentation`
+ - :doc:`faq/index`
+ - Looking for specific information?
-- **Documentation:** :doc:`internals/contributing/documentation-style` |
- :doc:`Building Open vSwitch Documentation <intro/install/documentation>` |
- :doc:`internals/documentation`
+ - :doc:`Full Table of Contents <contents>`
+ - :ref:`Index <genindex>`
Getting Help
-------------
-- Seeing an issue of potential bug? Report problems to bugs@openvswitch.org
+ - Reach out to us :doc:`here <internals/mailing-lists>`.
-- Looking for specific information? Try the :ref:`genindex`, :ref:`modindex` or
- the :doc:`detailed table of contents <contents>`.