Misc Changes 73/27773/2
authorShubhamRathi <shubhamiiitbackup@gmail.com>
Tue, 31 Jan 2017 09:44:34 +0000 (15:14 +0530)
committerShubhamRathi <shubhamiiitbackup@gmail.com>
Tue, 31 Jan 2017 12:15:54 +0000 (17:45 +0530)
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 <shubhamiiitbackup@gmail.com>
docs/featureprojects.rst
docs/index.rst
docs/release/installation.introduction.rst
docs/release/overview.rst
docs/release/subrelease.rst
docs/release/userguide.introduction.rst
docs/templates/development/design/index.rst [moved from docs/templates/developer/design/index.rst with 100% similarity]
docs/templates/development/overview/index.rst [moved from docs/templates/developer/overview/index.rst with 100% similarity]
docs/templates/development/overview/overview.rst [moved from docs/templates/developer/overview/overview.rst with 100% similarity]
docs/templates/development/requirements/index.rst [moved from docs/templates/developer/requirements/index.rst with 100% similarity]
docs/templates/testing/index.rst

index 8ff73c8..0869149 100644 (file)
@@ -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
index 98ee19f..848b817 100644 (file)
@@ -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
index 201112c..904c2d6 100644 (file)
@@ -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 <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`_.
 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 <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-noha/index.html>`_
 - High Availability LXD container hypervisor `os-nosdn-lxd-ha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-ha/index.html>`_
 
-======================
+
 Installation Procedure
 ======================
 
@@ -66,7 +69,7 @@ The instructions for each toolchain can be found in these links:
 - `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installationprocedure/index.html>`_
 - `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/2.0/docs/installationprocedure/index.html>`_
 
-=====================
+
 OPNFV Test Frameworks
 =====================
 
@@ -85,7 +88,7 @@ Many of the OPNFV test project provide user-guide documentation and installation
 - `Bottlenecks user guide <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/installationprocedure/index.html>`_
 - `Storage Performance Benchmarking for NFVI (StorPerf) user guide <http://artifacts.opnfv.org/storperf/colorado/2.0/docs/userguide/index.html>`_
 
-==============
+
 Security Notes
 ==============
 
index cd1b5d0..cc0a30d 100644 (file)
@@ -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
 ===========================
 
index eeac296..ffcb60c 100644 (file)
@@ -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
index 48112e7..27a0128 100644 (file)
@@ -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
 ================
 
index 9793092..392b39f 100644 (file)
@@ -1 +1 @@
-.. To be decided
\ No newline at end of file
+.. To be decided