Reorganize documentation in new structure

Remove the to-be-reorganized folder and reorganize
documentation in properly named subfolders.

Modified conf.py to reflect yardstick project name.

Modified index.rst with introduction about yardstick.

Templates were moved to new subfolder, no changes in
the content.

Jira:YARDSTICK-133

Change-Id: Iea5948733c57ff57eb946f44739b69d0e7291356
Signed-off-by: Ana C <ana.cunha@ericsson.com>

diff --git a/docs/etc/conf.py b/docs/etc/conf.py
index 0066035..d433d1d 100644 (file)
--- a/docs/etc/conf.py
+++ b/docs/etc/conf.py
@@ -18,7 +18,7 @@ master_doc = 'index'
 pygments_style = 'sphinx'
 html_use_index = False
 
-pdf_documents = [('index', u'OPNFV', u'OPNFV Project', u'OPNFV')]
+pdf_documents = [('index', u'OPNFV', u'OPNFV Yardstick', u'OPNFV')]
 pdf_fit_mode = "shrink"
 pdf_stylesheets = ['sphinx','kerning','a4']
 #latex_domain_indices = False
@@ -28,7 +28,7 @@ latex_elements = {
     'printindex': '',
 }
 
-project = u'OPNFV: Template documentation config'
+project = u'OPNFV Yardstick: NFV Infrastructure Verification'
 copyright = u'%s, OPNFV' % datetime.date.today().year
 version = u'1.0.0'
 release = u'1.0.0'

diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644 (file)
index 0000000..072b179
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,56 @@
+.. OPNFV Yardstick documentation master file.
+   Add chapters and user guides using the
+   root `toctree` directive.
+
+.. image:: ../etc/opnfv-logo.png
+  :height: 40
+  :width: 200
+  :alt: OPNFV
+  :align: left
+
+=================
+Yardstick Project
+=================
+
+Welcome to Yardstick's documentation !
+
+.. _Yardstick: https://wiki.opnfv.org/yardstick
+
+Yardstick_ is an OPNFV testing project.
+
+The project goal is to verify infrastructure compliance, from the perspective
+of a VNF.
+
+The project scope is the development of a test framework, test cases and test
+stimuli.
+
+This document introduces the methodology applied in Yardstick_ project, which
+decomposes typical VNF work-load performance metrics into a number of
+characteristics/performance vectors, each of them can be represented by
+distinct test-cases.
+
+The user guides and test cases delivered for the release are included.
+
+Contents:
+
+Yardstick Project Description
+=============================
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+User Guides
+===========
+
+.. toctree::
+    :maxdepth: 1
+
+Indices
+=======
+
+* :ref:`search`
+
+Revision: _sha1_
+
+Build date: |today|

diff --git a/docs/to-be-reorganized/Yardstick_task_templates.rst b/docs/source/templates/Yardstick_task_templates.rst
similarity index 100%
rename from docs/to-be-reorganized/Yardstick_task_templates.rst
rename to docs/source/templates/Yardstick_task_templates.rst

diff --git a/docs/to-be-reorganized/testcase_description_template.rst b/docs/source/templates/testcase_description_template.rst
similarity index 100%
rename from docs/to-be-reorganized/testcase_description_template.rst
rename to docs/source/templates/testcase_description_template.rst

diff --git a/docs/to-be-reorganized/index.rst b/docs/to-be-reorganized/index.rst
deleted file mode 100644 (file)
index 5e078d2..0000000
--- a/docs/to-be-reorganized/index.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-.. 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
-=======================================
-
-Contents:
-
-.. toctree::
-   :numbered:
-   :maxdepth: 4
-
-   Yardstick_task_templates.rst
-   testcase_description_template.rst  
-
-Indices and tables
-==================
-
-* :ref:`search`
-
-Revision: _sha1_
-
-Build date: |today|