Restructure docs

DOCS directory restructured according to:
https://wiki.opnfv.org/display/DOC/Documentation+Guide

Now:
 - release
    - release notes

 - testing
    - developer
       - dev guide (this is to be released on docs.opnfv.org)
       - internship (docs about intern projects)

    - user (this is to be released on docs.opnfv.org)
       - config guide
       - user guide

Change-Id: I1851189601aac3c5989f19f99d779efe23dbf3d1
Signed-off-by: jose.lausuch <jose.lausuch@ericsson.com>

4 files changed, 0 insertions, 547 deletions

diff --git a/docs/internship/security_group/index.rst b/docs/internship/security_group/index.rst
deleted file mode 100644
index d1cdbdd8f..000000000
--- a/docs/internship/security_group/index.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-=======
-License
-=======
-
-Functest Docs are licensed under a Creative Commons Attribution 4.0
-International License.
-You should have received a copy of the license along with this.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-==================================
-Functest Security group test cases
-==================================
-
-Author: Girish Sukhatankar
-mentors: D.Blaisonneau, J.Lausuch, M.Richomme
-
-Abstract
-========
-
-
-Version history
-===============
-
-+------------+----------+------------------+------------------------+
-| **Date**   | **Ver.** | **Author**       | **Comment**            |
-|            |          |                  |                        |
-+------------+----------+------------------+------------------------+
-| 2016-??-?? | 0.0.1    | Morgan Richomme  | Beginning of the       |
-|            |          | (Orange)         | Internship             |
-+------------+----------+------------------+------------------------+
-
-
-Overview:
-=========
-
-
-
-
-Problem Statement:
-------------------
-
-
-
-Curation Phase
---------------
-
-
-
-
-
-Schedule:
-=========
-
-
-
-+--------------------------+------------------------------------------+
-| **Date**                 | **Comment**                              |
-|                          |                                          |
-+--------------------------+------------------------------------------+
-| December  - January      | ........                                 |
-+--------------------------+------------------------------------------+
-| January  - february      | ........                                 |
-+--------------------------+------------------------------------------+
-
-
-References:
-===========
-
-.. _`[1]` : https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Security+groups+test+case+in+Functest
-
diff --git a/docs/internship/testapi_evolution/index.rst b/docs/internship/testapi_evolution/index.rst
deleted file mode 100644
index 6a1cde7df..000000000
--- a/docs/internship/testapi_evolution/index.rst
+++ /dev/null
@@ -1,237 +0,0 @@
-=======
-License
-=======
-
-Functest Docs are licensed under a Creative Commons Attribution 4.0
-International License.
-You should have received a copy of the license along with this.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-==================
-Test API evolution
-==================
-
-Author: Sakala Venkata Krishna Rohit
-Mentors: S. Feng, J.Lausuch, M.Richomme
-
-Abstract
-========
-
-The testapi is used by all the test opnfv projects to report results.
-It is also used to declare projects, test cases and labs. A major refactoring
-has been done in Colorado with the introduction of swagger. The testapi is defined in Functest
-developer guide. The purpose of this project is to add more features to the testapi that automate
-the tasks that are done manually now, though there are tasks other than automation.
-
-Version history
-===============
-
-+------------+----------+------------------+------------------------+
-| **Date**   | **Ver.** | **Author**       | **Comment**            |
-|            |          |                  |                        |
-+------------+----------+------------------+------------------------+
-| 2016-11-14 | 0.0.1    | Morgan Richomme  | Beginning of the       |
-|            |          | (Orange)         | Internship             |
-+------------+----------+------------------+------------------------+
-| 2017-02-17 | 0.0.2    | S.V.K Rohit      | End of the Internship  |
-|            |          | (IIIT Hyderabad) |                        |
-+------------+----------+------------------+------------------------+
-
-Overview:
-=========
-
-The internhip time period was from Nov 14th to Feb 17th. The project prosposal page is here `[1]`_.
-The intern project was assigned to Svk Rohit and was mentored by S. Feng, J.Lausuch, M.Richomme.
-The link to the patches submitted is `[2]`_. The internship was successfully completed and the
-documentation is as follows.
-
-Problem Statement:
-------------------
-
-The problem statement could be divided into pending features that needed to be added into testapi
-repo. The following were to be accomplished within the internship time frame.
-
-* **Add verification jenkins job for the testapi code**
-    The purpose of this job is to verify whehter the unit tests are successful or not with the
-    inclusion of the patchset submitted.
-
-* **Automatic update of opnfv/testapi docker image**
-    The docker image of testapi is hosted in the opnfv docker hub. To ensure that the testapi image
-    is always updated with the repository, automatic updation of the image is necessary and a job
-    is triggered whenever a new patch gets merged.
-
-* **Automation deployment of testresults.opnfv.org/test/ website**
-    In the same manner as the docker image of testapi is updated, the testapi website needs to be
-    in sync with the repository code. So, a job has been added to the opnfv jenkins ci for the
-    updation of the testresults website.
-
-* **Generate static documentation of testapi calls**
-    The purpose of this is to give an static/offline view of testapi. If someone wants to have a
-    look at the Restful apis of testapi, he/she does't need to go to the website, he can download
-    a html page and view it anytime.
-
-* **Backup MongoDB of testapi**
-    The mongoDB needs to be backed up every week. Till now it was done manually, but due to this
-    internship, it is now automated using a jenkins job.
-
-* **Add token based authorization to the testapi calls**
-    The token based authorization was implemented to ensure that only ci_pods could access the
-    database. Authentication has been added to only delete/put/post requests.
-
-Curation Phase:
----------------
-
-The curation phase was the first 3 to 4 weeks of the internship. This phase was to get familiar
-with the testapi code and functionality and propose the solutions/tools for the tasks mentioned
-above. Swagger codegen was choosen out of the four tools proposed `[3]`_ for generating static
-documentaion.
-
-Also, specific amount of time was spent on the script flow of the jenkins jobs. The automatic
-deployment task involves accessing a remote server from inside the jenkins build. The deployment
-had to be done only after the docker image update is done. For these constraints to satisfy, a
-multijob jenkins job was choosen instead of a freestyle job.
-
-Important Links:
-----------------
-
-* MongoDB Backup Link                 - `[4]`_
-* Static Documentation                - `[5]`_
-* TestAPI Token addition to ci_pods   - `[6]`_
-
-Schedule:
-=========
-
-The progress and completion of the tasks is described in the below table.
-
-+--------------------------+------------------------------------------+
-| **Date**                 | **Comment**                              |
-|                          |                                          |
-+--------------------------+------------------------------------------+
-| Nov 14th - Dec 31st      | Understand Testapi code and the          |
-|                          | requirements.                            |
-+--------------------------+------------------------------------------+
-| Jan 1st  - Jan 7th       | Add jenkins job to create static         |
-|                          | documentation and write build scripts.   |
-+--------------------------+------------------------------------------+
-| Jan 8th  - Jan 21st      | Add verification jenkins job for unit    |
-|                          | tests.                                   |
-+--------------------------+------------------------------------------+
-| Jan 22nd - Jan 28th      | Add jenkins job for mongodb backup       |
-|                          |                                          |
-+--------------------------+------------------------------------------+
-| Jan 29th - Feb 11th      | Enable automatic deployment of           |
-|                          | testresults.opnfv.org/test/              |
-+--------------------------+------------------------------------------+
-| Feb 12th - Feb 17th      | Add token based authentication           |
-|                          |                                          |
-+--------------------------+------------------------------------------+
-
-FAQ's
-=====
-
-This section lists the problems that I have faced and the understanding that I have acquired during
-the internship. This section may help other developers in solving any errors casused because of the
-code written as a part of this internship.
-
-
-Test Api
---------
-
-What is the difference between defining data_file as "/etc/.." and "etc/.." in setup.cfg ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-If in the setup.cfg, it is defined as
-
-[files]
-data_files =
-etc/a.conf = etc/a.conf.sample
-
-then it ends up installed in the /usr/etc/. With this configuration, it would be installed
-correctly within a venv. but when it is defined as
-
-[files]
-data_files =
-/etc/a.conf = etc/a.conf.sample
-
-then it ends up installed on the root of the filesystem instead of properly be installed within the
-venv.
-
-Which attribute does swagger-codegen uses as the title in the generation of document generation ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-It uses the nickname of the api call in swagger as the title in the generation of the document
-generation.
-
-Does swagger-codegen take more than one yaml file as input ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-No, swagger-codegen only takes one yaml file as input to its jar file. If there more than one yaml
-file, one needs to merge them and give it as an input keeping mind the swagger specs.
-
-
-Jenkins & JJB
--------------
-
-Which scm macro is used for verification jenkins jobs ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-There are two macros for scm one is git-scm and other git-scm-gerrit. git-scm-gerrit is used for
-verification jenkins job.
-
-Does the virtualenv created in one build script exists in other build scripts too ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-No, the virtualenv created in one build script only exists in that build script/shell.
-
-What parameters are needed for the scm macros ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Project and Branch are the two parameters needed for scm macros.
-
-What is the directory inside the jenkins build ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The directory of the jenkins build is the directory of the repo. `ls $WORKSPACE` command will give
-you all the contents of the directory.
-
-How to include a bash script in jenkins job yaml file ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-An example might be apt here as an answer.
-
-builders:
-    - shell:
-        !include-raw: include-raw001-hello-world.sh
-
-
-How do you make a build server run on a specific machine ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-It can be done by defining a label parameter 'SLAVE_LABEL' or in OPNFV , there are macros for each
-server, one can use those parameter macros.
-Ex: opnfv-build-defaults. Note, if we use macro, then no need to define GIT_BASE, but if one uses
-SLAVE_LABEL, one needs to define a parameter GIT_BASE. This is because macro already has GIT_BASE
-defined.
-
-What job style should be used when there is a situation like one build should trigger other builds
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-or when different build scripts need to be run on different machines ?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-MultiJob style should be used as it has phases where each phase can be taken as a build scipt and
-can have its own parameters by which one can define the SLAVE_LABEL parameter.
-
-References:
-===========
-
-_`[1]` : https://wiki.opnfv.org/display/DEV/Intern+Project%3A+testapi+evolution
-
-_`[2]` : https://gerrit.opnfv.org/gerrit/#/q/status:merged+owner:%22Rohit+Sakala+%253Crohitsakala%2540gmail.com%253E%22
-
-_`[3]` : https://docs.google.com/document/d/1jWwVZ1ZpKgKcOS_zSz2KzX1nwg4BXxzBxcwkesl7krw/edit?usp=sharing
-
-_`[4]` : http://artifacts.opnfv.org/testapibackup.html
-
-_`[5]` : http://artifacts.opnfv.org/releng/docs/testapi.html
-
-_`[6]` : http://artifacts.opnfv.org/functest/docs/devguide/index.html#test-api-authorization
diff --git a/docs/internship/unit_tests/index.rst b/docs/internship/unit_tests/index.rst
deleted file mode 100644
index f969aa72d..000000000
--- a/docs/internship/unit_tests/index.rst
+++ /dev/null
@@ -1,70 +0,0 @@
-=======
-License
-=======
-
-Functest Docs are licensed under a Creative Commons Attribution 4.0
-International License.
-You should have received a copy of the license along with this.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-===================
-Functest Unit tests
-===================
-
-Author: Ashish Kumar
-Mentors: H.Yao, J.Lausuch, M.Richomme
-
-Abstract
-========
-
-
-Version history
-===============
-
-+------------+----------+------------------+------------------------+
-| **Date**   | **Ver.** | **Author**       | **Comment**            |
-|            |          |                  |                        |
-+------------+----------+------------------+------------------------+
-| 2016-??-?? | 0.0.1    | Morgan Richomme  | Beginning of the       |
-|            |          | (Orange)         | Internship             |
-+------------+----------+------------------+------------------------+
-
-
-Overview:
-=========
-
-
-
-
-Problem Statement:
-------------------
-
-
-
-Curation Phase
---------------
-
-
-
-
-
-Schedule:
-=========
-
-
-
-+--------------------------+------------------------------------------+
-| **Date**                 | **Comment**                              |
-|                          |                                          |
-+--------------------------+------------------------------------------+
-| December  - January      | ........                                 |
-+--------------------------+------------------------------------------+
-| January  - february      | ........                                 |
-+--------------------------+------------------------------------------+
-
-
-References:
-===========
-
-.. _`[1]` : https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Functest+unit+tests
-
diff --git a/docs/internship/vnf_catalog/index.rst b/docs/internship/vnf_catalog/index.rst
deleted file mode 100644
index df7633391..000000000
--- a/docs/internship/vnf_catalog/index.rst
+++ /dev/null
@@ -1,170 +0,0 @@
-=======
-License
-=======
-
-Functest Docs are licensed under a Creative Commons Attribution 4.0
-International License.
-You should have received a copy of the license along with this.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-=======================
-Open Source VNF Catalog
-=======================
-
-Author: Kumar Rishabh
-Mentors: B.Souville, M.Richomme, J.Lausuch
-
-Abstract
-========
-
-
-
-Version hissory
-===============
-
-+------------+----------+------------------+------------------------+
-| **Date**   | **Ver.** | **Author**       | **Comment**            |
-|            |          |                  |                        |
-+------------+----------+------------------+------------------------+
-| 2016-12-12 | 0.0.1    | Morgan Richomme  | Beginning of the       |
-|            |          | (Orange)         | Internship             |
-+------------+----------+------------------+------------------------+
-
-
-Overview:
-=========
-
-
-This project aims to create an Open Source catalog for reference and
-classification of Virtual Network Functions (VNFs)s available on
-Internet. The classification method proposed will be in sync with the
-requirements of Telcos active in NFV landscape. The project aims to have
-running web platform similar to [1] by the mid of internship (2nd week
-of March). By the penultimate month of internship I aim to have fully
-functional implementation of an Open Source VNF in functest.
-
-
-Problem Statement:
-------------------
-
-OPNFV aims to be the reference platform for development,
-standardization and integration of Open Source NFV components across
-various Open Source Platforms. It mainly deals with the infrastructure
-through the Network Function Virtualization Infrastructure (NFVI) and
-Virtual Infrastructure manager (VIM). The MANO (Management and
-orchestration) stacks have been introduced recently. VNFs are not
-directly in OPNFV scope, however VNFs are needed to test and qualify the
-infrastructure. In this regard having a common curated Open Source
-Reference VNF catalog would be of immense importance to community.
-
-Since major focus of OPNFV is Telcos, a curated platform targeted from
-industry point of view would be very useful. We plan to divide the
-entire project into three major phases(with some iterative improvements
-and overlaps)
-
-
-Curation Phase
---------------
-This phase pertains to studying various Open Source VNFs available and
-classification of them based on certain parameters. The parameters that
-I currently have in mind are:
- * Developer Metrics: These pertain to repo characteristics of VNF under
- study
-  * Usage Statistics - Activity, Number of Commits, stars
-  * Maturity Statistics - For instance if an NFV community decides code
-  coverage is important for them, it shows the NFV community is serious
-  about taking the project forward
- * Technical Tagging: These are the tags that pertain to technical
- characteristics of a VNF
-  * Broad Use Cases - Whether the VNF fits strictly in IaaS, PaaS or
-  SaaS layer or is an hybrid of two/all.
-  * Generic Use Cases - This in my opinion is the broadest
-  classification category. For instance a VNF could be built with a
-  broad idea of powering IOT devices at home or from usage perspective
-  of Telco Operators (vFW, vEPC, vIMS, vCDN, vAAA, vCPE,...).`[2]`_
-  * Fields of Application
-  * Library Status - Whether APIs are standardized, support RESTful
-  services.
-  * Dependency Forwarding Graph - This is pretty complex tagging
-  mechanism. It essentially tries to establish a graph relationship
-  between the VNFs (elementary VNFs are used in Service Function
-  Chaining chains such as Firewall, DPI, content enrichment,..). In my
-  opinion this is useful immensely. This will allow users to go to
-  platform and ask a question like - “I have this X tech stack to
-  support, Y and Z are my use cases, which NFVs should I use to support
-  this.
-  * Visitor Score - Based on `[1]`_ I plan to evolve a visitor score for
-  the platform. This will allow users to score an NFV on certain
-  parameters, may be post comments.
-
-**I plan to use the above three scores and evolve cumulative score which
-will be displayed next to each of the NFV on the platform.**
-
- * Platform building phase - This will involve erecting a Web Platform
- which will be similar to this  `[1]`_. I am decently familiar with
- Django and hence I will write the platform in Django. There are two
- action plans that I have in mind right now. Either I can start writing
- the platform simultaneously which will help keep track of my progress
- or I can write the platform after 1.5 - 2 months into the internship.
- Either way I aim to have the Web Platform ready by March 12.
-
- * Functest VNF implementation phase - This is the last phase that will
- involve writing a fully functional implementation of an Open Source VNF
- into Functest. I will undertake this after I am 3 months into the
- internship. I have a decent familiarity with python and hence I think
- it shouldn’t be too difficult. I need to decide how complex the VNFI
- should undertake this exercise for (e.g. AAA such as free radius sounds
- relatively easy, vCDN is much more challenging).
- This will be decided in consent with my mentors.
-
-
-
-
-Schedule:
-=========
-I plan to take this project in 6 months time frame as I want to use it
-as a chance to read more about NFVs in particular and SDN in general
-
-
-+--------------------------+------------------------------------------+
-| **Date**                 | **Comment**                              |
-|                          |                                          |
-+--------------------------+------------------------------------------+
-| December 12 - January 12 | Study the above mentioned metrics        |
-|                          | Decide which of them are important for   |
-|                          | community (and which are not).           |
-+--------------------------+------------------------------------------+
-| January 12 - January 27  | Make a database for the above studied    |
-|                          | metrics and evolve it further based on   |
-|                          | Mentors’ input. + associated API         |
-+--------------------------+------------------------------------------+
-| January 27 - February 5  | Compile the data collected above and make|
-|                          | it public. Although I can keep everything|
-|                          | public from the beginning too. My        |
-|                          | rationale of not making the entire data  |
-|                          | public in initial stage as the errors    |
-|                          | caused by me could be misleading for     |
-|                          | developers.                              |
-+--------------------------+------------------------------------------+
-| February 5 - March 5     | Erect the Web Platform and release it    |
-|                          | for restricted group for alpha testing.  |
-+--------------------------+------------------------------------------+
-| March 5 - March 12       | Make it public. Release it to public for |
-|                          | beta testing. Fix Bugs.                  |
-+--------------------------+------------------------------------------+
-| March 12 - April 12      | Start working on implementation of an    |
-|                          | Open Source VNF in Functest.             |
-+--------------------------+------------------------------------------+
-| April 12 - May 12        | I will decided what to do here based on  |
-|                          | discussion with mentors.                 |
-+--------------------------+------------------------------------------+
-
-
-References:
-===========
-
-.. _`[1]` : Openhub: https://www.openhub.net/explore/projects
-
-.. _`[2]` : ETSI NFV White Paper: https://portal.etsi.org/Portals/0/TBpages/NFV/Docs/NFV_White_Paper3.pdf
-
-.. _`[3]` : https://wiki.opnfv.org/display/DEV/Intern+Project%3A+Open+Source+VNF+catalog