Fix minor Documentation Formatting Errors

These include wrongly indented bullet points, title underlines, and
malfomed links. Templates which are used for project documentation are
also excluded from builds as they are orphaned pages.

Change-Id: Iaabfb5f2bbf0b9bdfabec622e0b75dd23ea9e472
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>

diff --git a/docs/conf.py b/docs/conf.py
index c03114a..d966487 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -67,7 +67,7 @@ language = None
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = []
+exclude_patterns = ['templates/*', 'how-to-use-docs/files/*', 'development/opnfvsecguide/*']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

diff --git a/docs/how-to-use-docs/documentation-guide.rst b/docs/how-to-use-docs/documentation-guide.rst
index 0f2c3bf..9315a47 100644 (file)
--- a/docs/how-to-use-docs/documentation-guide.rst
+++ b/docs/how-to-use-docs/documentation-guide.rst
@@ -22,7 +22,7 @@ Read :ref:`this page <include-documentation>` which elaborates on how documentat
 Licencing your documentation
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 All contributions to the OPNFV project are done in accordance with the OPNFV licensing requirements. Documentation in OPNFV is contributed
-in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_  and the `SPDX https://spdx.org/>`_ licence.
+in accordance with the `Creative Commons 4.0 <https://creativecommons.org/licenses/by/4.0/>`_  and the `SPDX <https://spdx.org/>`_ licence.
 All documentation files need to be licensed using the text below. The license may be applied in the first lines of
 all contributed RST files:
 

diff --git a/docs/how-to-use-docs/include-documentation.rst b/docs/how-to-use-docs/include-documentation.rst
index d1a5a62..1798469 100644 (file)
--- a/docs/how-to-use-docs/include-documentation.rst
+++ b/docs/how-to-use-docs/include-documentation.rst
@@ -1,4 +1,5 @@
 .. _include-documentation:
+
 ============================
 Including your Documentation
 ============================
@@ -229,7 +230,7 @@ specified output folder directory.
 
 
 Adding your project repository as a submodule
---------------------------
+---------------------------------------------
 
 Clone the opnfvdocs repository and your submodule to .gitmodules following the convention of the file
 
@@ -244,7 +245,10 @@ Clone the opnfvdocs repository and your submodule to .gitmodules following the c
   git review
 
 Removing a project repository as a submodule
---------------------------
+--------------------------------------------
+
+.. code-block:: bash
+
   git rm docs/submodules/$reponame
   rm -rf .git/modules/$reponame
   git config -f .git/config --remove-section submodule.$reponame 2> /dev/null

diff --git a/docs/index.rst b/docs/index.rst
index 191153f..8e55576 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,7 +16,7 @@ about network transformation.
    :maxdepth: 1
 
    release/overview
-   how-to-use-docs/getting.started
+   how-to-use-docs/documentation-guide
    release/installation.introduction
    release/userguide.introduction
    release/release-notes

diff --git a/docs/testing/developer/devguide/dev-guide.rst b/docs/testing/developer/devguide/dev-guide.rst
index 50ddf3a..69058f2 100644 (file)
--- a/docs/testing/developer/devguide/dev-guide.rst
+++ b/docs/testing/developer/devguide/dev-guide.rst
@@ -138,11 +138,11 @@ Code quality
 
 It is recommended to control the quality of the code of the testing projects,
 and more precisely to implement some verifications before any merge:
-  * pep8
-  * pylint
-  * unit tests (python 2.7)
-  * unit tests (python 3.5)
 
+* pep8
+* pylint
+* unit tests (python 2.7)
+* unit tests (python 3.5)
 
 The code of the test project must be covered by unit tests. The coverage
 shall be reasonable and not decrease when adding new features to the framework.
@@ -295,16 +295,17 @@ each test iteration):
 
   * VNF scale out/up tests (also plan to measure storage usage simultaneously): https://wiki.opnfv.org/pages/viewpage.action?pageId=12390101
   * Life-cycle event with throughputs (measure NFVI to support concurrent
-  network usage from different VM pairs):
-  https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Baseline+Stress+Test+Case+for+Bottlenecks+E+Release
+    network usage from different VM pairs):
+    https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Baseline+Stress+Test+Case+for+Bottlenecks+E+Release
 
 In OPNFV E release, we also plan to do **long duration testing** over OS Ocata.
 A separate CI pipe testing OPNFV XCI (OSA) is proposed to accomplish the job.
 We have applied specific pod for the testing.
 Proposals and details are listed below:
-  * https://wiki.opnfv.org/display/testing/Euphrates+Testing+needs
-  * https://wiki.opnfv.org/download/attachments/2926539/testing%20evolution%20v1_4.pptx?version=1&modificationDate=1503937629000&api=v2
-  * https://wiki.opnfv.org/download/attachments/2926539/Testing%20over%20Long%20Duration%20POD.pptx?version=2&modificationDate=1502943821000&api=v2
+
+* https://wiki.opnfv.org/display/testing/Euphrates+Testing+needs
+* https://wiki.opnfv.org/download/attachments/2926539/testing%20evolution%20v1_4.pptx?version=1&modificationDate=1503937629000&api=v2
+* https://wiki.opnfv.org/download/attachments/2926539/Testing%20over%20Long%20Duration%20POD.pptx?version=2&modificationDate=1502943821000&api=v2
 
 The long duration testing is supposed to be started when OPNFV E release is
 published.
@@ -317,7 +318,7 @@ How TOs
 =======
 
 Where can I find information on the different test projects?
-===========================================================
+============================================================
 On http://docs.opnfv.org! A section is dedicated to the testing projects. You
 will find the overview of the ecosystem and the links to the project documents.
 
@@ -376,8 +377,9 @@ Click on *Spec*, the list of available methods must be displayed.
    :alt: Testing Group Test API swagger
 
 For the declaration of a new project use the POST /api/v1/projects method.
+
 For the declaration of new test cases in an existing project, use the POST
- /api/v1/projects/{project_name}/cases method
+/api/v1/projects/{project_name}/cases method
 
  .. figure:: ../../../images/CreateCase.png
     :align: center

diff --git a/docs/testing/ecosystem/energy-monitoring.rst b/docs/testing/ecosystem/energy-monitoring.rst
index fa1f282..0c2cd35 100644 (file)
--- a/docs/testing/ecosystem/energy-monitoring.rst
+++ b/docs/testing/ecosystem/energy-monitoring.rst
@@ -35,10 +35,10 @@ The energy monitoring system in based on 3 software components:
 
    * Power info collector: poll server to collect instantaneous power consumption information
    * Energy recording API + influxdb: On one leg receive servers consumption and
-   on the other, scenarios notfication. It then able to establish te correlation
-   between consumption and scenario and stores it into a time-series database (influxdb)
+     on the other, scenarios notfication. It then able to establish te correlation
+     between consumption and scenario and stores it into a time-series database (influxdb)
    * Python SDK: A Python SDK using decorator to send notification to Energy
-   recording API from testcases scenarios
+     recording API from testcases scenarios
 
 Power Info Collector
 --------------------
@@ -66,7 +66,7 @@ Redfish API has been successfully tested on:
   * HP
   * Dell
   * Huawei (E9000 class servers used in OPNFV Community Labs are  IPMI 2.0
-  compliant and use Redfish login Interface through Browsers supporting JRE1.7/1.8)
+    compliant and use Redfish login Interface through Browsers supporting JRE1.7/1.8)
 
 Several test campaigns done with physical Wattmeter showed that IPMI results
 were notvery accurate but RedFish were. So if Redfish is available, it is
@@ -184,11 +184,11 @@ with
 | Parameter name            | Description                                |
 +===========================+============================================+
 | admin-influx-user-name    | Influx user with admin grants to create    |
-|---------------------------+--------------------------------------------+
++---------------------------+--------------------------------------------+
 | admin-password            | Influx password to set to admin user       |
-|---------------------------+--------------------------------------------+
++---------------------------+--------------------------------------------+
 | readonly-influx-user-name | Influx user with readonly grants to create |
-|---------------------------+--------------------------------------------+
++---------------------------+--------------------------------------------+
 | user-password             | Influx password to set to readonly user    |
 +---------------------------+--------------------------------------------+
 

diff --git a/docs/testing/ecosystem/overview.rst b/docs/testing/ecosystem/overview.rst
index ef7705b..709989a 100644 (file)
--- a/docs/testing/ecosystem/overview.rst
+++ b/docs/testing/ecosystem/overview.rst
@@ -188,11 +188,12 @@ The Test Database
 -----------------
 A Mongo DB Database was introduced for the Brahmaputra release.
 The following collections are declared in this database:
- * pods: the list of pods used for production CI
- * projects: the list of projects providing test cases
- * test cases: the test cases related to a given project
- * results: the results of the test cases
- * scenarios: the OPNFV scenarios tested in CI
+
+* pods: the list of pods used for production CI
+* projects: the list of projects providing test cases
+* test cases: the test cases related to a given project
+* results: the results of the test cases
+* scenarios: the OPNFV scenarios tested in CI
 
 This database can be used by any project through the Test API.
 Please note that projects may also use additional databases. The Test
@@ -275,7 +276,7 @@ per scenario and show:
 
  * the status of the deployment
  * the score from each test suite. There is no overall score, it is determined
- by each test project.
+   by each test project.
  * a trust indicator
 
 

diff --git a/docs/testing/testing-user.rst b/docs/testing/testing-user.rst
index ade27a6..7a57ed4 100644 (file)
--- a/docs/testing/testing-user.rst
+++ b/docs/testing/testing-user.rst
@@ -40,7 +40,7 @@ Functest
    ../submodules/functest/docs/testing/user/userguide/index
 
 NFVbench
------
+--------
 .. toctree::
    :maxdepth: 1