editorial fixes in apex docs

- add gitignore entries - drop common files under docs/etc - fix documentation titles - fix doc8 violation (length of lines) - removal of '_sha1_' for doc tracking - removal of opnfv logo insertion Change-Id: Ib0b39704c115f896f62a8ed8ec52257fcf84d544 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>

editorial fixes in apex docs
- add gitignore entries - drop common files under docs/etc - fix documentation titles - fix doc8 violation (length of lines) - removal of '_sha1_' for doc tracking - removal of opnfv logo insertion Change-Id: Ib0b39704c115f896f62a8ed8ec52257fcf84d544 Signed-off-by: Ryota MIBU <r-mibu@cq.jp.nec.com>
f5922480 · Ryota MIBU · ddb27a25 · f5922480 · ddb27a25 · ddb27a25
Commit f5922480 authored Dec 11, 2015 by Ryota MIBU
7 changed files
--- a/.gitignore
+++ b/.gitignore
+*~
+.*.sw?
+/docs_build/
+/docs_output/
+/releng/
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
-import datetime
-import sys
-import os
-
-try:
-    __import__('imp').find_module('sphinx.ext.numfig')
-    extensions = ['sphinx.ext.numfig']
-except ImportError:
-    # 'pip install sphinx_numfig'
-    extensions = ['sphinx_numfig']
-
-# numfig:
-number_figures = True
-figure_caption_prefix = "Fig."
-
-source_suffix = '.rst'
-master_doc = 'index'
-pygments_style = 'sphinx'
-html_use_index = False
-
-pdf_documents = [('index', u'Apex', u'Apex Project', u'OPNFV')]
-pdf_fit_mode = "shrink"
-pdf_stylesheets = ['sphinx','kerning','a4']
-#latex_domain_indices = False
-#latex_use_modindex = False
-
-latex_elements = {
-    'printindex': '',
-}
-
-project = u'Apex: OPNFV Installer'
-copyright = u'%s, OPNFV' % datetime.date.today().year
-version = u'1.0.0'
-release = u'1.0.0'
--- a/docs/etc/opnfv-logo.png
+++ b/docs/etc/opnfv-logo.png
--- a/docs/installation-instructions/index.rst
+++ b/docs/installation-instructions/index.rst
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
-Apex Table of Contents
-======================
+**************************************
+OPNFV Installation instructions (Apex)
+**************************************

 Contents:

@@ -19,12 +9,3 @@ Contents:
   :maxdepth: 4

   installation-instructions.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
-
-Revision: _sha1_
-
-Build date: |today|
--- a/docs/installation-instructions/installation-instructions.rst
+++ b/docs/installation-instructions/installation-instructions.rst
@@ -131,8 +131,8 @@ The Jumphost requirements are outlined below:

 3.     libvirt virtualization support.

-4.     minimum 2 networks and maximum 6 networks, multiple NIC and/or VLAN combinations are supported. This is virtualized for a VM
-       deployment.
+4.     minimum 2 networks and maximum 6 networks, multiple NIC and/or VLAN combinations are supported.
+       This is virtualized for a VM deployment.

 5.     The Bramaputra Apex RPM.

@@ -285,13 +285,17 @@ Install Bare Metal Jumphost
 Creating a Node Inventory File
 ------------------------------

-IPMI configuration information gathered in section `Execution Requirements (Bare Metal Only)`_ needs to be added to the ``instackenv.json`` file.
+IPMI configuration information gathered in section `Execution Requirements (Bare Metal Only)`_
+needs to be added to the ``instackenv.json`` file.

 1.  Make a copy of ``/var/opt/opnfv/instackenv.json.example`` into root's home directory: ``/root/instackenv.json``

 2.  Edit the file in your favorite editor.

-3.  The nodes dictionary contains a definition block for each baremetal host that will be deployed.  1 or more compute nodes and 3 controller nodes are required. (The example file contains blocks for each of these already).  It is optional at this point to add more compute nodes into the dictionary.
+3.  The nodes dictionary contains a definition block for each baremetal host that will be deployed.
+    1 or more compute nodes and 3 controller nodes are required.
+    (The example file contains blocks for each of these already).
+    It is optional at this point to add more compute nodes into the dictionary.

 4.  Edit the following values for each node:

@@ -311,9 +315,11 @@ IPMI configuration information gathered in section `Execution Requirements (Bare
 Creating a Network Environment File
 -----------------------------------

-Network environment information gathered in section `Network Requirements`_ needs to be added to the ``network-environment.yaml`` file.
+Network environment information gathered in section `Network Requirements`_
+needs to be added to the ``network-environment.yaml`` file.

-1. Make a copy of ``/var/opt/opnfv/network-environment.yaml`` into root's home directory: ``/root/network-environment.yaml``
+1. Make a copy of ``/var/opt/opnfv/network-environment.yaml`` into root's home
+directory: ``/root/network-environment.yaml``

 2. Edit the file in your favorite editor.

@@ -322,7 +328,8 @@ Network environment information gathered in section `Network Requirements`_ need
 Running ``opnfv-deploy``
 ------------------------

-You are now ready to deploy OPNFV!  ``opnfv-deploy`` will use the instackenv.json and network-environment.yaml to deploy OPNFV.
+You are now ready to deploy OPNFV!
+``opnfv-deploy`` will use the instackenv.json and network-environment.yaml to deploy OPNFV.
 The names of these files are important.  ``opnfv-deploy`` will look for ``instackenv.json`` and
 ``network-environment.yaml`` in the present working directory when it is run.

@@ -330,7 +337,11 @@ Follow the steps below to execute:

 1.  execute ``opnfv-deploy -i /path/to/instackenv.json -n /path/to/network-environment.yaml``

-2.  It will take about approximately 30 minutes to stand up instack, configure the deployment and execute the deployment.  If something goes wrong during this part of the process, it is most likely a problem with the setup of your network or the information in your configuration files.  You will also notice different outputs in your shell.
+2.  It will take about approximately 30 minutes to stand up instack,
+    configure the deployment and execute the deployment.
+    If something goes wrong during this part of the process,
+    it is most likely a problem with the setup of your network or the information in your configuration files.
+    You will also notice different outputs in your shell.

 3.  The message "Overcloud Deployed" will display when When the deployment is complete.  Just above this message there
    will be a URL that ends in port http://<host>:5000. This url is also the endpoint for the OPNFV Horizon Dashboard
@@ -381,7 +392,8 @@ Once connected to the OPNFV Dashboard make sure the OPNFV target system is worki

 1.  In the left pane, click Compute -> Images, click Create Image.

-2.  Insert a name "cirros", Insert an Image Location ``http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img``.
+2.  Insert a name "cirros", Insert an Image Location
+    ``http://download.cirros-cloud.net/0.3.4/cirros-0.3.4-x86_64-disk.img``.

 3.  Select format "QCOW2", select Public, then click Create Image.

@@ -393,7 +405,8 @@ Once connected to the OPNFV Dashboard make sure the OPNFV target system is worki

 7. Now go to Project -> Compute -> Instances, click Launch Instance.

-8. Enter Instance Name "first_instance", select Instance Boot Source "Boot from image", and then select Image Name "cirros".
+8. Enter Instance Name "first_instance", select Instance Boot Source "Boot from image",
+   and then select Image Name "cirros".

 9. Click Launch, status will cycle though a couple states before becoming "Active".

@@ -424,21 +437,28 @@ Follow the instructions in the `Install Bare Metal Jumphost`_ section.
 Running ``opnfv-deploy``
 ------------------------

-You are now ready to deploy OPNFV!  ``opnfv-deploy`` has virtual deployment capability that includes all of the configuration nessesary to deploy OPNFV with no modifications.
+You are now ready to deploy OPNFV!
+``opnfv-deploy`` has virtual deployment capability that includes all of
+the configuration nessesary to deploy OPNFV with no modifications.

-If no modifications are made to the included configurations the target environment will deploy with the following architecture:
+If no modifications are made to the included configurations the target environment
+will deploy with the following architecture:

    - 1 Instack VM

-    - The option of 3 control and 2 compute VMs (HA Deploy / default) or 1 control and 1 compute VM (Non-HA deploy / pass -n)
+    - The option of 3 control and 2 compute VMs (HA Deploy / default)
+      or 1 control and 1 compute VM (Non-HA deploy / pass -n)

-    - 2 networks, one for provisioning, internal API, storage and tenant networking traffic and a second for the external network
+    - 2 networks, one for provisioning, internal API,
+      storage and tenant networking traffic and a second for the external network

 Follow the steps below to execute:

 1.  ``opnfv-deploy --virtual [ --no-ha ]``

-2.  It will take approximately 30 minutes to stand up instack, define the target virtual machines, configure the deployment and execute the deployment.  You will notice different outputs in your shell.
+2.  It will take approximately 30 minutes to stand up instack,
+    define the target virtual machines, configure the deployment and execute the deployment.
+    You will notice different outputs in your shell.

 3.  When the deployment is complete you will see "Overcloud Deployed"

@@ -513,10 +533,3 @@ RDO Manager
 :Authors: Tim Rozet (trozet@redhat.com)
 :Authors: Dan Radez (dradez@redhat.com)
 :Version: 1.0
-
-**Documentation tracking**
-
-Revision: _sha1_
-
-Build date:  _date_
-
--- a/docs/release-notes/index.rst
+++ b/docs/release-notes/index.rst
-.. OPNFV Release Engineering documentation, created by
-   sphinx-quickstart on Tue Jun  9 19:12:31 2015.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-.. image:: ../etc/opnfv-logo.png
-  :height: 40
-  :width: 200
-  :alt: OPNFV
-  :align: left
-
-Apex Table of Contents
-======================
+************************
+OPNFV Apex Release Notes
+************************

 Contents:

@@ -19,12 +9,3 @@ Contents:
   :maxdepth: 4

   release-notes.rst
-
-Indices and tables
-==================
-
-* :ref:`search`
-
-Revision: _sha1_
-
-Build date: |today|
--- a/docs/release-notes/release-notes.rst
+++ b/docs/release-notes/release-notes.rst
-=============================================================================================
+============================================================================================
 OPNFV Release Notes for the Bramaputra release of OPNFV when using Apex as a deployment tool
-=============================================================================================
+============================================================================================


 .. contents:: Table of Contents
@@ -65,7 +65,8 @@ node.

 - Documentation is built by Jenkins
 - .iso image is built by Jenkins
- Jenkins deploys a Bramaputra release with the Apex deployment toolchain baremetal, which includes 3 control+network nodes, and 2 compute nodes.
+- Jenkins deploys a Bramaputra release with the Apex deployment toolchain baremetal,
+  which includes 3 control+network nodes, and 2 compute nodes.

 Release Data
 ============
@@ -220,10 +221,3 @@ http://wiki.opnfv.org/releases/bramaputra
 :Authors: Tim Rozet (trozet@redhat.com)
 :Authors: Dan Radez (dradez@redhat.com)
 :Version: 1.0.0
-
-**Documentation tracking**
-
-Revision: _sha1_
-
-Build date:  _date_
-