JIRA:PARSER-17 Clean up documentation setup

Change-Id: I2863a76a5d5417c184283fdf97282c94359162dc

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
new file mode 100644 (file)
index 0000000..0066035
--- /dev/null
+++ b/docs/etc/conf.py
@@ -0,0 +1,34 @@
+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'OPNFV', u'OPNFV 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'OPNFV: Template documentation config'
+copyright = u'%s, OPNFV' % datetime.date.today().year
+version = u'1.0.0'
+release = u'1.0.0'

diff --git a/docs/etc/opnfv-logo.png b/docs/etc/opnfv-logo.png
new file mode 100644 (file)
index 0000000..1519503
Binary files /dev/null and b/docs/etc/opnfv-logo.png differ

diff --git a/docs/documentation-example.rst b/docs/how-to-use-docs/documentation-example.rst
similarity index 79%
rename from docs/documentation-example.rst
rename to docs/how-to-use-docs/documentation-example.rst
index 8264732..e4068b1 100644 (file)
--- a/docs/documentation-example.rst
+++ b/docs/how-to-use-docs/documentation-example.rst
@@ -1,5 +1,12 @@
 .. two dots create a comment. please leave this logo at the top of each of your rst files.
-
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+.. these two pipes are to seperate the logo from the first title
+|
+|
 How to create documentation for your OPNFV project
 ==================================================
 
@@ -7,13 +14,16 @@ this is the directory structure of the docs/ directory that can be found in the
 
 .. code-block:: bash
 
-    ./yourfolder_name1/file_name1.rst
-    ./yourfolder_nameN/file_nameX.rst
-    ./documentation-example.rst
-    ./index.rst
+    ./etc
+    ./etc/opnfv-logo.png
+    ./etc/conf.py
+    ./how-to-use-docs
+    ./how-to-use-docs/documentation-example.rst
+    ./how-to-use-docs/index.rst
 
-To create your own documentation, Create any number of directories (depending on your need) and place
-in each of them an index.rst. This index file must refence your other rst files.
+To create your own documentation, Create any number of directories
+(depending on your need) and place in each of them an index.rst.
+This index file must refence your other rst files.
 
 * Here is an example index.rst
 
@@ -46,7 +56,6 @@ The Sphinx Build
 When you push documentation changes to gerrit a jenkins job will create html documentation.
 
 * Verify Jobs
-
 For verify jobs a link to the documentation will show up as a comment in gerrit for you to see the result.
 
 * Merge jobs

diff --git a/docs/index.rst b/docs/how-to-use-docs/index.rst
similarity index 56%
rename from docs/index.rst
rename to docs/how-to-use-docs/index.rst
index aeeaf56..36710b3 100644 (file)
--- a/docs/index.rst
+++ b/docs/how-to-use-docs/index.rst
@@ -1,8 +1,14 @@
-.. OPNFV Parser documentation, created by
-   sphinx-quickstart.
+.. 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
+
 Example Documentation table of contents
 =======================================
 
@@ -13,10 +19,6 @@ Contents:
    :maxdepth: 4
 
    documentation-example.rst
-   ./tosca2heat/parser_new_keywords.rst
-   ./tosca2heat/simple_rnc_definition/vRNC_tosca_intro.rst
-   ./tosca2heat/simple_rnc_definition/image/vRNC_Definition.bmp
-   ./tosca2heat/simple_rnc_definition/image/vRNC_Topology.bmp
 
 Indices and tables
 ==================

diff --git a/docs/intro.md b/docs/intro.md
deleted file mode 100644 (file)
index 0220b47..0000000
--- a/docs/intro.md
+++ /dev/null
@@ -1 +0,0 @@
-##Parser Project Introduction##

diff --git a/docs/intro/index.rst b/docs/intro/index.rst
new file mode 100644 (file)
index 0000000..b60e9a5
--- /dev/null
+++ b/docs/intro/index.rst
@@ -0,0 +1,13 @@
+****************
+Parser Introduction Documents
+****************
+
+This is the directory to store introduction documents for Parser project.
+
+See also https://wiki.opnfv.org/parser .
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   intro.rst

diff --git a/docs/intro/intro.rst b/docs/intro/intro.rst
new file mode 100644 (file)
index 0000000..3272c65
--- /dev/null
+++ b/docs/intro/intro.rst
@@ -0,0 +1,32 @@
+..
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
+ License.
+
+ http://creativecommons.org/licenses/by/3.0/legalcode
+
+============================
+Introduction of Parser Project
+============================
+
+In NFV, various templates (such as descriptors, records and so on) are utilized
+to describe the deployment requirements (such as basic VM requirements – vCPU,
+memory, storage, as well as the NFV acceleration management requirement such as
+Huge Pages support, SR-IOV, NUMA affinity, DPDK support etc.),
+the post-instaniation records (such as storage usage report, CPU performance
+report etc.) or other purposes. However in order to make these templates
+adaptable and feasible for purpose like deployment orchestration/automation,
+certain tooling mechanism that provides template translation is necessary.
+
+Project Parser will help to provide such tooling mechanism, by parsing Telecom
+operators’ descriptors/records into TOSCA/CAMP templates and then further
+translate TOSCA/CAMP templates into certain common templates, which could be
+used in IaaS orchestration projects like OpenStack Heat.
+
+For Release B, Parser offers the following capabilities:
+* Integration of Heat-Translator Liberty release code. (both heat in-tree code and standalone package are provided)
+* Yang2Tosca module which offers the capability to translate yang based
+scriptors to tosca formate templates. Users could further use Heat-translator
+module to translate this tosca template to Heat Orchestration template.
+Yang2Tosca module could be installed seperately after user installed
+OPNFV B release platform.
+* Use Case Analysis documents which include RNC use case analysis and Parser keyword proposal.

diff --git a/docs/tosca2heat/simple_rnc_definition/Simple_RNC.yaml b/docs/tosca2heat/examples/Simple_RNC.yaml
similarity index 100%
rename from docs/tosca2heat/simple_rnc_definition/Simple_RNC.yaml
rename to docs/tosca2heat/examples/Simple_RNC.yaml

diff --git a/docs/tosca2heat/simple_rnc_definition/Simple_RNC_definition.yaml b/docs/tosca2heat/examples/Simple_RNC_definition.yaml
similarity index 100%
rename from docs/tosca2heat/simple_rnc_definition/Simple_RNC_definition.yaml
rename to docs/tosca2heat/examples/Simple_RNC_definition.yaml

diff --git a/docs/tosca2heat/TOSCA_nfv_definition_1_0.yaml b/docs/tosca2heat/examples/TOSCA_nfv_definition_1_0.yaml
similarity index 100%
rename from docs/tosca2heat/TOSCA_nfv_definition_1_0.yaml
rename to docs/tosca2heat/examples/TOSCA_nfv_definition_1_0.yaml

diff --git a/docs/tosca2heat/simple_rnc_definition/image/vRNC_Definition.bmp b/docs/tosca2heat/image/vRNC_Definition.bmp
similarity index 100%
rename from docs/tosca2heat/simple_rnc_definition/image/vRNC_Definition.bmp
rename to docs/tosca2heat/image/vRNC_Definition.bmp

diff --git a/docs/tosca2heat/simple_rnc_definition/image/vRNC_Topology.bmp b/docs/tosca2heat/image/vRNC_Topology.bmp
similarity index 100%
rename from docs/tosca2heat/simple_rnc_definition/image/vRNC_Topology.bmp
rename to docs/tosca2heat/image/vRNC_Topology.bmp

diff --git a/docs/tosca2heat/index.rst b/docs/tosca2heat/index.rst
new file mode 100644 (file)
index 0000000..c7ae649
--- /dev/null
+++ b/docs/tosca2heat/index.rst
@@ -0,0 +1,24 @@
+****************
+TOSCA To Heat Documents
+****************
+
+This is the directory to store documents regarding tosca to heat translation.
+
+The "parser_new_keywords" document demonstrate a set of keywords concluded by
+Parser team that need to be supported in tosca to heat translation. However
+it should be noted that these keywords only serve as a roadmap. We will start
+from Release C to indicate which specific set of keywords are supported in
+Parser.
+
+The "vRNC_tosca_intro" document describes Parser's use case analysis on vRNC scenario.
+
+The "example" folder contains examples of tosca-nfv standard and vRNC scenario.
+
+See also https://wiki.opnfv.org/parser .
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   parser_new_keywords.rst
+   vRNC_tosca_intro.rst

diff --git a/docs/tosca2heat/parser_new_keywords.rst b/docs/tosca2heat/parser_new_keywords.rst
index d705d17..f91cacd 100644 (file)
--- a/docs/tosca2heat/parser_new_keywords.rst
+++ b/docs/tosca2heat/parser_new_keywords.rst
@@ -1,3 +1,10 @@
+..
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
+ License.
+
+ http://creativecommons.org/licenses/by/3.0/legalcode
+
+===================
 New Parser keywords
 ===================
 

diff --git a/docs/tosca2heat/simple_rnc_definition/vRNC_tosca_intro.rst b/docs/tosca2heat/vRNC_tosca_intro.rst
similarity index 90%
rename from docs/tosca2heat/simple_rnc_definition/vRNC_tosca_intro.rst
rename to docs/tosca2heat/vRNC_tosca_intro.rst
index d81e530..30f0f8c 100644 (file)
--- a/docs/tosca2heat/simple_rnc_definition/vRNC_tosca_intro.rst
+++ b/docs/tosca2heat/vRNC_tosca_intro.rst
@@ -1,3 +1,10 @@
+..
+ This work is licensed under a Creative Commons Attribution 3.0 Unported
+ License.
+
+ http://creativecommons.org/licenses/by/3.0/legalcode
+
+================
 1. vRNC Topology
 ================