diff options
| author | Flavio Leitner <fbl@sysclose.org> | 2020-12-28 19:02:55 -0300 |
|---|---|---|
| committer | Ben Pfaff <blp@ovn.org> | 2021-01-07 12:13:33 -0800 |
| commit | 7f79ae2fb677649e00868bf03b42fc81f7f293a3 (patch) | |
| tree | a36bdd93816e515a4b82c0159646ad8e24c4d7a5 /Documentation/internals | |
| parent | fcf281b0b61078dc8ca23ebe1e2198c3f7c6763f (diff) | |
| download | openvswitch-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/internals')
6 files changed, 18 insertions, 18 deletions
diff --git a/Documentation/internals/bugs.rst b/Documentation/internals/bugs.rst index 116afa9ea..8d493106b 100644 --- a/Documentation/internals/bugs.rst +++ b/Documentation/internals/bugs.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -============================== -Reporting Bugs in Open vSwitch -============================== +============== +Reporting Bugs +============== We are eager to hear from users about problems that they have encountered with Open vSwitch. This file documents how best to report bugs so as to ensure that diff --git a/Documentation/internals/contributing/coding-style-windows.rst b/Documentation/internals/contributing/coding-style-windows.rst index 1edf2285f..d0868f7b3 100644 --- a/Documentation/internals/contributing/coding-style-windows.rst +++ b/Documentation/internals/contributing/coding-style-windows.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -========================================== -Open vSwitch Windows Datapath Coding Style -========================================== +============================= +Windows Datapath Coding Style +============================= The :doc:`coding style <coding-style>` guide gives the flexibility for each platform to use its own coding style for the kernel datapath. This file diff --git a/Documentation/internals/contributing/coding-style.rst b/Documentation/internals/contributing/coding-style.rst index f70f783ad..7fc320080 100644 --- a/Documentation/internals/contributing/coding-style.rst +++ b/Documentation/internals/contributing/coding-style.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -========================= -Open vSwitch Coding Style -========================= +============ +Coding Style +============ This file describes the coding style used in most C files in the Open vSwitch distribution. However, Linux kernel code datapath directory follows the Linux diff --git a/Documentation/internals/contributing/documentation-style.rst b/Documentation/internals/contributing/documentation-style.rst index deb07d9f5..045cdf696 100644 --- a/Documentation/internals/contributing/documentation-style.rst +++ b/Documentation/internals/contributing/documentation-style.rst @@ -23,9 +23,9 @@ Avoid deeper levels because they do not render well. -================================ -Open vSwitch Documentation Style -================================ +=================== +Documentation Style +=================== This file describes the documentation style used in all documentation found in Open vSwitch. Documentation includes any documents found in ``Documentation`` diff --git a/Documentation/internals/release-process.rst b/Documentation/internals/release-process.rst index fb39ccb5d..922d59852 100644 --- a/Documentation/internals/release-process.rst +++ b/Documentation/internals/release-process.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -============================ -Open vSwitch Release Process -============================ +=============== +Release Process +=============== This document describes the process ordinarily used for Open vSwitch development and release. Exceptions are sometimes necessary, so all of the diff --git a/Documentation/internals/security.rst b/Documentation/internals/security.rst index 8b4e5c3f4..444d07c35 100644 --- a/Documentation/internals/security.rst +++ b/Documentation/internals/security.rst @@ -21,9 +21,9 @@ Avoid deeper levels because they do not render well. -=============================== -Open vSwitch's Security Process -=============================== +================ +Security Process +================ This is a proposed security vulnerability reporting and handling process for Open vSwitch. It is based on the OpenStack vulnerability management process |