Correct structure

Add docs folder
Update HTML theme
Remove example docs
JIRA: SFC-3

Change-Id: If0158796aee5f020f3bb4403b8a67952f9e6bb26
Signed-off-by: blsaws <blsaws@hotmail.com>

25 files changed, 161 insertions, 0 deletions

diff --git a/VnfMgrSim/INFO b/INFO
index 76298d34..76298d34 100644
--- a/VnfMgrSim/INFO
+++ b/INFO
diff --git a/VnfMgrSim/LICENSE b/LICENSE
index eab09245..eab09245 100644
--- a/VnfMgrSim/LICENSE
+++ b/LICENSE
diff --git a/VnfMgrSim/NAME/__init__.py b/NAME/__init__.py
index e69de29b..e69de29b 100644
--- a/VnfMgrSim/NAME/__init__.py
+++ b/NAME/__init__.py
diff --git a/VnfMgrSim/README b/README
index 04d252a4..04d252a4 100644
--- a/VnfMgrSim/README
+++ b/README
diff --git a/docs/design/architecture.rst b/docs/design/architecture.rst
new file mode 100644
index 00000000..24be1675
--- /dev/null
+++ b/docs/design/architecture.rst
@@ -0,0 +1,4 @@
+Architecture
+============
+
+This section will describe the architectural approach to incorporating SFC into the OPNFV platform.
\ No newline at end of file
diff --git a/docs/design/definitions.rst b/docs/design/definitions.rst
new file mode 100644
index 00000000..effaf0ec
--- /dev/null
+++ b/docs/design/definitions.rst
@@ -0,0 +1,59 @@
+Definitions
+===========
+
+Definitions of most terms used here are provided in the `IETF SFC Architecture draft <https://datatracker.ietf.org/doc/draft-ietf-sfc-architecture/>`_. Additional terms specific to the OPNFV SFC project are defined below.
+
+.. list-table:: Definitions
+   :widths: 15 85
+   :header-rows: 1
+
+   * - Term
+     - Meaning
+
+   * - ...
+     - ...
+
+Abbreviations
+=============
+.. list-table:: Abbreviations
+   :widths: 15 85
+   :header-rows: 1
+
+   * - Abbreviation
+     - Term
+
+   * - NS
+     - Network Service
+
+   * - NFVO
+     - Network Function Virtualization Orchestrator
+
+   * - NF
+     - Network Function
+
+   * - RSP
+     - Rendered Service Path
+
+   * - SF
+     - Service Function
+
+   * - SFC
+     - Service Function Chain(ing)
+
+   * - SFF
+     - Service Function Forwarder
+
+   * - SFP
+     - Service Function Path
+
+   * - VNF
+     - Virtual Network Function
+
+   * - VNFM
+     - Virtual Network Function Manager
+
+   * - VNF-FG
+     - Virtual Network Function Forwarding Graph
+
+   * - VIM
+     - Virtual Infrastructure Manager
diff --git a/docs/design/index.rst b/docs/design/index.rst
new file mode 100644
index 00000000..c878b872
--- /dev/null
+++ b/docs/design/index.rst
@@ -0,0 +1,32 @@
+.. OPNFV Service Function Chaining (SFC) documentation
+
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+|
+|
+Service Function Chaining (SFC)
+===============================
+
+Contents:
+
+.. toctree::
+   :numbered:
+   :maxdepth: 4
+
+   introduction.rst
+   definitions.rst
+   usecases.rst
+   architecture.rst
+   requirements.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|
diff --git a/docs/design/introduction.rst b/docs/design/introduction.rst
new file mode 100644
index 00000000..746ba05c
--- /dev/null
+++ b/docs/design/introduction.rst
@@ -0,0 +1,23 @@
+.. 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
+|
+|
+Introduction
+============
+
+..
+ This work is licensed under a Creative Commons Attribution 3.0 Unported License.
+
+ http://creativecommons.org/licenses/by/3.0/legalcode
+ 
+.. NOTE::
+   This is the working documentation for the SFC project.
+
+The `OPNFV Service Function Chaining (SFC) <https://wiki.opnfv.org/sfc>`_ project aims to provide the ability to define an ordered list of a network services (e.g. firewalls, NAT, QoS). These service are then "stitched" together in the network to create a service chain. This project provides the infrastructure to install the upstream ODL SFC implementation project in an NFV environment.
+
+
diff --git a/docs/design/requirements.rst b/docs/design/requirements.rst
new file mode 100644
index 00000000..dbedc6f7
--- /dev/null
+++ b/docs/design/requirements.rst
@@ -0,0 +1,4 @@
+Requirements
+============
+
+This section will define requirements for the initial OPNFV SFC implementation, including those requirements driving upstream project enhancements.
diff --git a/docs/design/usecases.rst b/docs/design/usecases.rst
new file mode 100644
index 00000000..9b886982
--- /dev/null
+++ b/docs/design/usecases.rst
@@ -0,0 +1,4 @@
+Use Cases
+=========
+
+This section will outline use cases driving the initial OPNFV SFC implementation.
\ No newline at end of file
diff --git a/docs/etc/conf.py b/docs/etc/conf.py
new file mode 100644
index 00000000..9a0c229a
--- /dev/null
+++ b/docs/etc/conf.py
@@ -0,0 +1,35 @@
+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
+html_theme = 'sphinx_rtd_theme'
+
+pdf_documents = [('index', u'SFC', u'SFC 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: Service Function Chaining (SFC)'
+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
index 00000000..1519503e
--- /dev/null
+++ b/docs/etc/opnfv-logo.png
diff --git a/VnfMgrSim/setup.py b/setup.py
index 9ff16995..9ff16995 100644
--- a/VnfMgrSim/setup.py
+++ b/setup.py
diff --git a/VnfMgrSim/tests/NAME_tests.py b/tests/NAME_tests.py
index 9f83104c..9f83104c 100644
--- a/VnfMgrSim/tests/NAME_tests.py
+++ b/tests/NAME_tests.py
diff --git a/VnfMgrSim/tests/__init__.py b/tests/__init__.py
index e69de29b..e69de29b 100644
--- a/VnfMgrSim/tests/__init__.py
+++ b/tests/__init__.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_main.py b/vnfmgr/vnfmgr_main.py
index b5ab8be1..b5ab8be1 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_main.py
+++ b/vnfmgr/vnfmgr_main.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/__init__.py b/vnfmgr/vnfmgr_odl/__init__.py
index e69de29b..e69de29b 100644
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/__init__.py
+++ b/vnfmgr/vnfmgr_odl/__init__.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json
index 998d1e07..998d1e07 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-RSP-HttpPost.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json
index 34449647..34449647 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFCs-HttpPut.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json
index 191fd540..191fd540 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFFs-HttpPut.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json
index da1f2c45..da1f2c45 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFPs-HttpPut.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json
index 1ea27e79..1ea27e79 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json
+++ b/vnfmgr/vnfmgr_odl/sample_config/RestConf-SFs-HttpPut.json
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_odl/vnfmgr_odl.py b/vnfmgr/vnfmgr_odl/vnfmgr_odl.py
index 4d35aebb..4d35aebb 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_odl/vnfmgr_odl.py
+++ b/vnfmgr/vnfmgr_odl/vnfmgr_odl.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_os/__init__.py b/vnfmgr/vnfmgr_os/__init__.py
index e69de29b..e69de29b 100644
--- a/VnfMgrSim/vnfmgr/vnfmgr_os/__init__.py
+++ b/vnfmgr/vnfmgr_os/__init__.py
diff --git a/VnfMgrSim/vnfmgr/vnfmgr_os/vnfmgr_os.py b/vnfmgr/vnfmgr_os/vnfmgr_os.py
index 00678503..00678503 100755
--- a/VnfMgrSim/vnfmgr/vnfmgr_os/vnfmgr_os.py
+++ b/vnfmgr/vnfmgr_os/vnfmgr_os.py