summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorShubhamRathi <shubhamiiitbackup@gmail.com>2017-01-31 15:14:34 +0530
committerShubhamRathi <shubhamiiitbackup@gmail.com>2017-01-31 17:45:54 +0530
commit8b68e7a23e6a393429aa3e68712e1ba69b2f6cec (patch)
treeeb620695d56d6d053376befcc44509f8c9cd4cea /docs
parent5bdc3f8e8e2e5b2109e84ddf7783a36482185d8e (diff)
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 <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/featureprojects.rst2
-rw-r--r--docs/index.rst23
-rw-r--r--docs/release/installation.introduction.rst17
-rw-r--r--docs/release/overview.rst9
-rw-r--r--docs/release/subrelease.rst2
-rw-r--r--docs/release/userguide.introduction.rst9
-rw-r--r--docs/templates/development/design/index.rst (renamed from docs/templates/developer/design/index.rst)0
-rw-r--r--docs/templates/development/overview/index.rst (renamed from docs/templates/developer/overview/index.rst)0
-rw-r--r--docs/templates/development/overview/overview.rst (renamed from docs/templates/developer/overview/overview.rst)0
-rw-r--r--docs/templates/development/requirements/index.rst (renamed from docs/templates/developer/requirements/index.rst)0
-rw-r--r--docs/templates/testing/index.rst2
11 files changed, 32 insertions, 32 deletions
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 <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
==============
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/development/design/index.rst
index 392b39f48..392b39f48 100644
--- a/docs/templates/developer/design/index.rst
+++ b/docs/templates/development/design/index.rst
diff --git a/docs/templates/developer/overview/index.rst b/docs/templates/development/overview/index.rst
index caf4dfc70..caf4dfc70 100644
--- a/docs/templates/developer/overview/index.rst
+++ b/docs/templates/development/overview/index.rst
diff --git a/docs/templates/developer/overview/overview.rst b/docs/templates/development/overview/overview.rst
index 498dc0662..498dc0662 100644
--- a/docs/templates/developer/overview/overview.rst
+++ b/docs/templates/development/overview/overview.rst
diff --git a/docs/templates/developer/requirements/index.rst b/docs/templates/development/requirements/index.rst
index 392b39f48..392b39f48 100644
--- a/docs/templates/developer/requirements/index.rst
+++ b/docs/templates/development/requirements/index.rst
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