From 8b68e7a23e6a393429aa3e68712e1ba69b2f6cec Mon Sep 17 00:00:00 2001 From: ShubhamRathi Date: Tue, 31 Jan 2017 15:14:34 +0530 Subject: Misc Changes Renamed developer/ to development/ in templates. Corrected chapter level markup in docs/release/ Moved testing above developement in index Change-Id: I950f69bf2ac60e97b260ecfbb4b870a42f8a233b Signed-off-by: ShubhamRathi --- docs/featureprojects.rst | 2 +- docs/index.rst | 23 +++++++---------------- docs/release/installation.introduction.rst | 17 ++++++++++------- docs/release/overview.rst | 9 ++++++--- docs/release/subrelease.rst | 2 +- docs/release/userguide.introduction.rst | 9 ++++++--- docs/templates/developer/design/index.rst | 1 - docs/templates/developer/overview/index.rst | 15 --------------- docs/templates/developer/overview/overview.rst | 16 ---------------- docs/templates/developer/requirements/index.rst | 1 - docs/templates/development/design/index.rst | 1 + docs/templates/development/overview/index.rst | 15 +++++++++++++++ docs/templates/development/overview/overview.rst | 16 ++++++++++++++++ docs/templates/development/requirements/index.rst | 1 + docs/templates/testing/index.rst | 2 +- 15 files changed, 65 insertions(+), 65 deletions(-) delete mode 100644 docs/templates/developer/design/index.rst delete mode 100644 docs/templates/developer/overview/index.rst delete mode 100644 docs/templates/developer/overview/overview.rst delete mode 100644 docs/templates/developer/requirements/index.rst create mode 100644 docs/templates/development/design/index.rst create mode 100644 docs/templates/development/overview/index.rst create mode 100644 docs/templates/development/overview/overview.rst create mode 100644 docs/templates/development/requirements/index.rst diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index 8ff73c842..0869149cb 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -153,4 +153,4 @@ Software fast-path quality metrics ../submodules/fastpathmetrics/docs/userguide/index ../submodules/fastpathmetrics/docs/requirements/index - ../submodules/fastpathmetrics/docs/configguide/index \ No newline at end of file + ../submodules/fastpathmetrics/docs/configguide/index diff --git a/docs/index.rst b/docs/index.rst index 98ee19f84..848b817fe 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -21,15 +21,6 @@ Release Documentation release/subrelease -Developer Documentation ------------------------------------ - -.. toctree:: - :maxdepth: 1 - - featureprojects - - Testing Documentation ------------------------------------- @@ -41,10 +32,10 @@ Testing Documentation submodules/yardstick/docs/userguide/index submodules/vswitchperf/docs/index -.. Commenting the below out until we actually use it -.. Indices and tables -.. ================== -.. -.. * :ref:`genindex` -.. * :ref:`modindex` -.. * :ref:`search` \ No newline at end of file +Developer Documentation +----------------------------------- + +.. toctree:: + :maxdepth: 1 + + featureprojects diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 201112cad..904c2d66b 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -1,8 +1,11 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 - .. (c) Sofia Wallin Ericsson AB +.. (c) Sofia Wallin Ericsson AB + +==================== +OPNFV Installation +==================== -======== Abstract ======== @@ -14,7 +17,7 @@ integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and JOID. Each installer provides the ability to install a common OPNFV platform as well as integrating additional features delivered through a variety of scenarios by the OPNFV community. -============ + Introduction ============ @@ -29,7 +32,7 @@ An OPNFV installation requires either a physical, or virtual, infrastructure env in the `Pharos specification `_. When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. -========= + Scenarios ========= @@ -51,7 +54,7 @@ description documents provided: - LXD container hypervisor `os-nosdn-lxd-noha `_ - High Availability LXD container hypervisor `os-nosdn-lxd-ha `_ -====================== + Installation Procedure ====================== @@ -66,7 +69,7 @@ The instructions for each toolchain can be found in these links: - `Fuel installation instruction `_ - `Joid installation instruction `_ -===================== + OPNFV Test Frameworks ===================== @@ -85,7 +88,7 @@ Many of the OPNFV test project provide user-guide documentation and installation - `Bottlenecks user guide `_ - `Storage Performance Benchmarking for NFVI (StorPerf) user guide `_ -============== + Security Notes ============== diff --git a/docs/release/overview.rst b/docs/release/overview.rst index cd1b5d0f9..cc0a30ded 100644 --- a/docs/release/overview.rst +++ b/docs/release/overview.rst @@ -2,7 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Open Platform for NFV Project, Inc. and its contributors -============ +=============== +OPNFV Overview +=============== + Introduction ============ @@ -40,7 +43,7 @@ topics (such as the MANO components and applications themselves), OPNFV aims to NFV services by increasing performance and power efficiency improving reliability, availability and serviceability, and delivering comprehensive platform instrumentation. -=========================== + OPNFV Platform Architecture =========================== @@ -176,7 +179,7 @@ This server-either physical or virtual-is first installed with the installation that then installs OpenStack and other components on the controller nodes and compute nodes. See the `OPNFV User Guide`_ for more details. -=========================== + The OPNFV Testing Ecosystem =========================== diff --git a/docs/release/subrelease.rst b/docs/release/subrelease.rst index eeac29659..ffcb60cf9 100644 --- a/docs/release/subrelease.rst +++ b/docs/release/subrelease.rst @@ -31,4 +31,4 @@ Joid :maxdepth: 1 ../submodules/joid/docs/releasenotes/index - ../submodules/joid/docs/installationprocedure/index \ No newline at end of file + ../submodules/joid/docs/installationprocedure/index diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 48112e78e..27a012802 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -2,7 +2,10 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Sofia Wallin (sofia.wallin@ericssion.com) -======== +================ +OPNFV Userguide +================ + Abstract ======== @@ -16,7 +19,7 @@ This document is not intended to replace or replicate documentation from other open source projects such as OpenStack or OpenDaylight, rather highlight the features and capabilities delivered through the OPNFV project. -============ + Introduction ============ @@ -32,7 +35,7 @@ scenario will include different source components or configurations. Scenarios are designed to enable specific features and capabilities in the platform that can be leveraged by the OPNFV user community. -================ + Feature Overview ================ diff --git a/docs/templates/developer/design/index.rst b/docs/templates/developer/design/index.rst deleted file mode 100644 index 392b39f48..000000000 --- a/docs/templates/developer/design/index.rst +++ /dev/null @@ -1 +0,0 @@ -.. To be decided diff --git a/docs/templates/developer/overview/index.rst b/docs/templates/developer/overview/index.rst deleted file mode 100644 index caf4dfc70..000000000 --- a/docs/templates/developer/overview/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International -.. License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) OPNFV, Ericsson AB and others. - -============================================= -OPNFV Overview -============================================= - -For example, the title might be "Qtip Danube Overview" - -.. toctree:: - :maxdepth: 1 - - overview diff --git a/docs/templates/developer/overview/overview.rst b/docs/templates/developer/overview/overview.rst deleted file mode 100644 index 498dc0662..000000000 --- a/docs/templates/developer/overview/overview.rst +++ /dev/null @@ -1,16 +0,0 @@ -============================================== -OPNFV Overview -============================================== - -.. contents:: - :depth: 3 - :local: - -Introduction ----------------- -Describing the components and behaviours in a manner that helps people understand the platform and how to work with it - -Upgrades from ------------------------------------ - -Describe the new features diff --git a/docs/templates/developer/requirements/index.rst b/docs/templates/developer/requirements/index.rst deleted file mode 100644 index 392b39f48..000000000 --- a/docs/templates/developer/requirements/index.rst +++ /dev/null @@ -1 +0,0 @@ -.. To be decided diff --git a/docs/templates/development/design/index.rst b/docs/templates/development/design/index.rst new file mode 100644 index 000000000..392b39f48 --- /dev/null +++ b/docs/templates/development/design/index.rst @@ -0,0 +1 @@ +.. To be decided diff --git a/docs/templates/development/overview/index.rst b/docs/templates/development/overview/index.rst new file mode 100644 index 000000000..caf4dfc70 --- /dev/null +++ b/docs/templates/development/overview/index.rst @@ -0,0 +1,15 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) OPNFV, Ericsson AB and others. + +============================================= +OPNFV Overview +============================================= + +For example, the title might be "Qtip Danube Overview" + +.. toctree:: + :maxdepth: 1 + + overview diff --git a/docs/templates/development/overview/overview.rst b/docs/templates/development/overview/overview.rst new file mode 100644 index 000000000..498dc0662 --- /dev/null +++ b/docs/templates/development/overview/overview.rst @@ -0,0 +1,16 @@ +============================================== +OPNFV Overview +============================================== + +.. contents:: + :depth: 3 + :local: + +Introduction +---------------- +Describing the components and behaviours in a manner that helps people understand the platform and how to work with it + +Upgrades from +----------------------------------- + +Describe the new features diff --git a/docs/templates/development/requirements/index.rst b/docs/templates/development/requirements/index.rst new file mode 100644 index 000000000..392b39f48 --- /dev/null +++ b/docs/templates/development/requirements/index.rst @@ -0,0 +1 @@ +.. To be decided diff --git a/docs/templates/testing/index.rst b/docs/templates/testing/index.rst index 9793092e5..392b39f48 100644 --- a/docs/templates/testing/index.rst +++ b/docs/templates/testing/index.rst @@ -1 +1 @@ -.. To be decided \ No newline at end of file +.. To be decided -- cgit 1.2.3-korg