Merge "Add clover design documents"

diff --git a/INFO.yaml b/INFO.yaml
new file mode 100644 (file)
index 0000000..eb32801
--- /dev/null
+++ b/INFO.yaml
@@ -0,0 +1,52 @@
+---
+project: 'OPNFV documentation project (opnfvdocs)'
+project_creation_date: 'March 31, 2015'
+project_category: 'Documentation'
+lifecycle_state: 'Incubation'
+project_lead: &opnfv_opnfvdocs_ptl
+    name: 'Sofia Wallin'
+    email: 'sofia.wallin@ericsson.com'
+    id: 'sofiawallin'
+    company: 'ericsson.com'
+    timezone: 'Unknown'
+primary_contact: *opnfv_opnfvdocs_ptl
+issue_tracking:
+    type: 'jira'
+    url: 'https://jira.opnfv.org/projects/DOCS'
+    key: 'DOCS'
+mailing_list:
+    type: 'mailman2'
+    url: 'opnfv-tech-discuss@lists.opnfv.org'
+    tag: '[opnfvdocs]'
+realtime_discussion:
+    type: irc
+    server: 'freenode.net'
+    channel: '#opnfv-opnfvdocs'
+meetings:
+    - type: 'gotomeeting+irc'
+      agenda:  # eg: 'https://wiki.opnfv.org/display/'
+      url:  # eg: 'https://global.gotomeeting.com/join/819733085'
+      server: 'freenode.net'
+      channel: '#opnfv-meeting'
+      repeats: 'weekly'
+      time:  # eg: '16:00 UTC'
+repositories:
+    - 'opnfvdocs'
+committers:
+    - <<: *opnfv_opnfvdocs_ptl
+    - name: 'Christopher Price'
+      email: 'christopher.price@est.tech'
+      company: 'est.tech'
+      id: 'ChristopherPrice'
+    - name: 'Fatih Degirmenci'
+      email: 'fdegir@gmail.com'
+      company: 'gmail.com'
+      id: 'fdegir'
+    - name: 'Ryota Mibu'
+      email: 'r-mibu@cq.jp.nec.com'
+      company: 'cq.jp.nec.com'
+      id: 'r-mibu'
+tsc:
+    # yamllint disable rule:line-length
+    approval: 'http//ircbot.wl.linuxfoundation.org/meetings/opnfv-meeting/2015/opnfv-meeting.2015-03-31-13.56.html'
+    # yamllint enable rule:line-length

diff --git a/docker/Dockerfile b/docker/Dockerfile
new file mode 100644 (file)
index 0000000..fe1ff80
--- /dev/null
+++ b/docker/Dockerfile
@@ -0,0 +1,23 @@
+FROM ubuntu:14.04
+
+MAINTAINER Julien Zhang <julienjut@gmail.com>
+LABEL version="0.1" Description="OPNFVDocs Docker container"
+
+ARG BRANCH=master
+ARG build=html
+ENV BRANCH=$BRANCH
+ENV build=$build
+
+# Dependencies for sphinx, pip and git
+RUN apt-get update && apt-get install -y \
+    python-pip python-sphinx git
+
+RUN git clone --depth=1 --branch=$BRANCH https://git.opnfv.org/opnfvdocs /opnfvdocs
+RUN pip install -r /opnfvdocs/etc/requirements.txt
+RUN pip install virtualenv
+RUN rm -rf /var/lib/apt-lists/* /root/.cache/pip /opnfvdocs/.git
+
+ADD ./entrypoint.sh /sbin/entrypoint.sh
+RUN chmod 755 /sbin/entrypoint.sh
+
+ENTRYPOINT /sbin/entrypoint.sh

diff --git a/docker/README.md b/docker/README.md
new file mode 100644 (file)
index 0000000..c7b119c
--- /dev/null
+++ b/docker/README.md
@@ -0,0 +1,28 @@
+# OPNFVDoc tool readme
+------------------------
+
+This docker container is used for building OPNFV docs from **rst** format files for each feature
+project. The output is just like contents in [opnfvdocs](http://docs.opnfv.org/) website. You can
+review the contents through web browser. Currently *PDF* output is not good enough and it will make
+the container image size 3x larger. PDF output format is not supported in this release.
+
+# Usage
+
+* The default build is *html*, you can run:
+```
+docker run -it --rm -v ./some-opnfv-repo:/docs -v /tmp/output:/output \
+     opnfv/opnfvdocs
+```
+
+* Then if you want to build epub, etc you could pass it as an arg:
+```
+docker run -it --rm -v ./some-opnfv-repo:/docs -v /tmp/output:/output \
+     -e build=epub opnfv/opnfvdocs
+```
+
+## env parameters
+* build: [html | singlehtml | epub]
+
+## two directory parameters
+* /docs: **mandatory**, used for source files
+* /output: **optional**, used for storing the built result

diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh
new file mode 100644 (file)
index 0000000..6982bff
--- /dev/null
+++ b/docker/entrypoint.sh
@@ -0,0 +1,28 @@
+#!/bin/bash -x
+
+if [ ! -d /docs ]; then
+    echo source path /docs not exist and no repo for building
+    exit 1
+fi
+
+cd /docs
+for item in conf.py _templates _static
+do
+    cp -r /opnfvdocs/docs/$item ./
+done
+
+# use the same procedure as verify Job
+# [TODO]create a common macro can be consumed in Docker and Jenkins
+sudo pip install virtualenv
+virtualenv $WORKSPACE/venv
+. $WORKSPACE/venv/bin/activate
+pip install --upgrade pip
+pip freeze
+pip install tox
+tox -edocs
+
+# copy the building result to host
+if [ -d /output ]; then
+    cp -R ./docs/_build /output
+fi
+

diff --git a/docs/index.rst b/docs/index.rst
index b12470b..191153f 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -16,6 +16,7 @@ about network transformation.
    :maxdepth: 1
 
    release/overview
+   how-to-use-docs/getting.started
    release/installation.introduction
    release/userguide.introduction
    release/release-notes

diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst
index 3fe891a..8aad8a4 100644 (file)
--- a/docs/release/release-notes.rst
+++ b/docs/release/release-notes.rst
@@ -16,6 +16,8 @@ Project release notes:
 
 :ref:`Apex Release Notes <apex-releasenotes>`
 
+:ref:`Auto Release Notes <auto-releasenotes>`
+
 :ref:`Barometer Release Notes <barometer-releasenotes>`
 
 :ref:`Bottlenecks Release Notes <bottlenecks-releasenotes>`

diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst
index 02267ea..75c5366 100644 (file)
--- a/docs/release/userguide.introduction.rst
+++ b/docs/release/userguide.introduction.rst
@@ -58,6 +58,7 @@ OPNFV wiki page at http://wiki.opnfv.org for more details.
 Feature Configuration Guides
 ============================
 
+- :ref:`Auto Configuration Guide <auto-configguide>`
 - :ref:`Barometer Configuration Guide <barometer-configguide>`
 - :ref:`Doctor Configuration Guide <doctor-configguide>`
 - :ref:`Domino Configuration Guide <domino-configguide>`
@@ -76,6 +77,7 @@ Feature Configuration Guides
 Feature User Guides
 ===================
 
+- :ref:`Auto User Guide <auto-userguide>`
 - :ref:`Barometer User Guide <barometer-userguide>`
 - :ref:`Doctor User Guide <doctor-userguide>`
 - :ref:`Domino User Guide <domino-userguide>`

diff --git a/docs/submodules/apex b/docs/submodules/apex
index 29367db..0cd3c6c 160000 (submodule)
--- a/docs/submodules/apex
+++ b/docs/submodules/apex
@@ -1 +1 @@
-Subproject commit 29367db39d60da9ba839e0ee2254b164fd43e2a1
+Subproject commit 0cd3c6cef32adb1bf9d26414ed73bd9373b0c407

diff --git a/docs/submodules/armband b/docs/submodules/armband
index feb3b54..0d7a183 160000 (submodule)
--- a/docs/submodules/armband
+++ b/docs/submodules/armband
@@ -1 +1 @@
-Subproject commit feb3b54f39d9710e50b9e0a29036d1dd69f4f3cd
+Subproject commit 0d7a1834aea3bde3e27892919ae731b5cdae5560

diff --git a/docs/submodules/auto b/docs/submodules/auto
index e1730ab..c74e914 160000 (submodule)
--- a/docs/submodules/auto
+++ b/docs/submodules/auto
@@ -1 +1 @@
-Subproject commit e1730ab6e1b355baec45def4f0ed305998895a77
+Subproject commit c74e914c628819473625c3bfd03d4535e6e64bb8

diff --git a/docs/submodules/availability b/docs/submodules/availability
index 1c2ce63..c1ee363 160000 (submodule)
--- a/docs/submodules/availability
+++ b/docs/submodules/availability
@@ -1 +1 @@
-Subproject commit 1c2ce630bf5eba741860232b89e67afc2f7cf71c
+Subproject commit c1ee3631b59009ff61450808e2bd33fe1d4b17f2

diff --git a/docs/submodules/barometer b/docs/submodules/barometer
index 6f1d06b..ed61877 160000 (submodule)
--- a/docs/submodules/barometer
+++ b/docs/submodules/barometer
@@ -1 +1 @@
-Subproject commit 6f1d06bd5bce5803611483a69c88c822b391375d
+Subproject commit ed61877e2ba389ada8c4e60160b43e999f23d60b

diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks
index 7b61cfd..c4a33d0 160000 (submodule)
--- a/docs/submodules/bottlenecks
+++ b/docs/submodules/bottlenecks
@@ -1 +1 @@
-Subproject commit 7b61cfd2e0c7bed6004f82d11b4cdc37a2e12cad
+Subproject commit c4a33d033497629b5e0b2ef1b269742eb26b0502

diff --git a/docs/submodules/calipso b/docs/submodules/calipso
index 648a394..8f3b074 160000 (submodule)
--- a/docs/submodules/calipso
+++ b/docs/submodules/calipso
@@ -1 +1 @@
-Subproject commit 648a394f7a318443dfd82f790f83a79616c26905
+Subproject commit 8f3b074fafd2271557a152f43a676abaee6a32ea

diff --git a/docs/submodules/clover b/docs/submodules/clover
index 1985282..2208c1d 160000 (submodule)
--- a/docs/submodules/clover
+++ b/docs/submodules/clover
@@ -1 +1 @@
-Subproject commit 19852828dbbcf602b39872303a0366626c34ca8f
+Subproject commit 2208c1dbef93cb46e862bb7ce6b6d8e0a7541304

diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv
index cb4d867..b69dfdc 160000 (submodule)
--- a/docs/submodules/compass4nfv
+++ b/docs/submodules/compass4nfv
@@ -1 +1 @@
-Subproject commit cb4d8671693d27b26de34852795782d28046117a
+Subproject commit b69dfdca72868b884a583d15ad70ffd0c991dd52

diff --git a/docs/submodules/container4nfv b/docs/submodules/container4nfv
index 6535bcc..84ce45c 160000 (submodule)
--- a/docs/submodules/container4nfv
+++ b/docs/submodules/container4nfv
@@ -1 +1 @@
-Subproject commit 6535bcca66f3dcee06a454f5b37e499701cc59a7
+Subproject commit 84ce45c8bf6e03f0373d9c46e0a8b7e0b3faa605

diff --git a/docs/submodules/daisy b/docs/submodules/daisy
index 0f6f121..6a7ee18 160000 (submodule)
--- a/docs/submodules/daisy
+++ b/docs/submodules/daisy
@@ -1 +1 @@
-Subproject commit 0f6f12141ae7997713cbab0296038579376b476d
+Subproject commit 6a7ee18538561c772b0bfbc48805e2a2de74a9c6

diff --git a/docs/submodules/doctor b/docs/submodules/doctor
index 0a76b9c..f06386c 160000 (submodule)
--- a/docs/submodules/doctor
+++ b/docs/submodules/doctor
@@ -1 +1 @@
-Subproject commit 0a76b9c6e1303cee5b93795b05c5a9ca115bbd56
+Subproject commit f06386c6b436a0adce7b96c6a1d59b5d02ed31fb

diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail
index b2c513d..71ba21f 160000 (submodule)
--- a/docs/submodules/dovetail
+++ b/docs/submodules/dovetail
@@ -1 +1 @@
-Subproject commit b2c513d028451cc142e1647bf749f245020bf15b
+Subproject commit 71ba21ff906d4104a81442d4712aac13cf4906d4

diff --git a/docs/submodules/fuel b/docs/submodules/fuel
index 9dfa19d..2d2f599 160000 (submodule)
--- a/docs/submodules/fuel
+++ b/docs/submodules/fuel
@@ -1 +1 @@
-Subproject commit 9dfa19de4ae2962152c866657c9a2f60f96a1795
+Subproject commit 2d2f59907d578d266e1aa19040314dc15b27c0c6

diff --git a/docs/submodules/functest b/docs/submodules/functest
index a51e1ca..e521f24 160000 (submodule)
--- a/docs/submodules/functest
+++ b/docs/submodules/functest
@@ -1 +1 @@
-Subproject commit a51e1ca848bd3044e928855650eef4dd4bbaced4
+Subproject commit e521f245ee0575427de49b92506199c6316bb29f

diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6
index d85b910..dfcc074 160000 (submodule)
--- a/docs/submodules/ipv6
+++ b/docs/submodules/ipv6
@@ -1 +1 @@
-Subproject commit d85b9104619fe3477eb067a369238dcbdcad8576
+Subproject commit dfcc0745ef76e684593c8284f9dcb81cca2f7959

diff --git a/docs/submodules/joid b/docs/submodules/joid
index 976a5aa..c0bc95b 160000 (submodule)
--- a/docs/submodules/joid
+++ b/docs/submodules/joid
@@ -1 +1 @@
-Subproject commit 976a5aa1011379c4a82b13f8dde4b76cbec1ba16
+Subproject commit c0bc95b384aa0e5a398aa35a300081919898d1da

diff --git a/docs/submodules/moon b/docs/submodules/moon
index 8c4396c..85209d2 160000 (submodule)
--- a/docs/submodules/moon
+++ b/docs/submodules/moon
@@ -1 +1 @@
-Subproject commit 8c4396c505ea245af4a542cf87b185a010484f5f
+Subproject commit 85209d217c85ada8a55487f5c77fb2990ad0c209

diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench
index ca7bc60..63bab64 160000 (submodule)
--- a/docs/submodules/nfvbench
+++ b/docs/submodules/nfvbench
@@ -1 +1 @@
-Subproject commit ca7bc608e72076dba0b9db50b473ab0d0d18c0e6
+Subproject commit 63bab64fe0babc5a198d0a0457c4fb0a58cfe32f

diff --git a/docs/submodules/ovn4nfv b/docs/submodules/ovn4nfv
index e0e7d50..9623c07 160000 (submodule)
--- a/docs/submodules/ovn4nfv
+++ b/docs/submodules/ovn4nfv
@@ -1 +1 @@
-Subproject commit e0e7d50a8dbf70117baec66451df7f594a7db233
+Subproject commit 9623c07f59e059ed0b1cdc6fdfec9c7d9996d88d

diff --git a/docs/submodules/parser b/docs/submodules/parser
index d6c75bc..cabfeec 160000 (submodule)
--- a/docs/submodules/parser
+++ b/docs/submodules/parser
@@ -1 +1 @@
-Subproject commit d6c75bcf6eb3dd88a2dee1478236dcf09b73daf9
+Subproject commit cabfeecb3259c5e22488756d91b6f72d27c4c18a

diff --git a/docs/submodules/pharos b/docs/submodules/pharos
index a02c9cc..a3c0456 160000 (submodule)
--- a/docs/submodules/pharos
+++ b/docs/submodules/pharos
@@ -1 +1 @@
-Subproject commit a02c9ccbd8cd58104dacb048833556e209ef21d3
+Subproject commit a3c0456cc14a75e96808505e670d0cab37b30abc

diff --git a/docs/submodules/qtip b/docs/submodules/qtip
index d601cde..4dccf13 160000 (submodule)
--- a/docs/submodules/qtip
+++ b/docs/submodules/qtip
@@ -1 +1 @@
-Subproject commit d601cde6a374d4e5b5138aab4cf4e156df5dbbc4
+Subproject commit 4dccf13a77e11b3a4cd9066eebc0e61d62e0909b

diff --git a/docs/submodules/releng b/docs/submodules/releng
index 112eb07..8d84d7d 160000 (submodule)
--- a/docs/submodules/releng
+++ b/docs/submodules/releng
@@ -1 +1 @@
-Subproject commit 112eb0719a5139191e7fd58a1a5b72bcb3a3694d
+Subproject commit 8d84d7d9ac290135804b8ab3f5506e175db8d29e

diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci
index c5d8334..a486682 160000 (submodule)
--- a/docs/submodules/releng-xci
+++ b/docs/submodules/releng-xci
@@ -1 +1 @@
-Subproject commit c5d83347c1550efe2e7eb4e114ac2fc0a18f6e6a
+Subproject commit a4866825aafc744e861a3badb86df314bbf22f39

diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf
index a3fc5b6..3981ce6 160000 (submodule)
--- a/docs/submodules/samplevnf
+++ b/docs/submodules/samplevnf
@@ -1 +1 @@
-Subproject commit a3fc5b620eec70c9e2c043a66d0b358c29d51106
+Subproject commit 3981ce6fed44db09af235100526ab8bc1666e38e

diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn
index cc10bd4..fc149c8 160000 (submodule)
--- a/docs/submodules/sdnvpn
+++ b/docs/submodules/sdnvpn
@@ -1 +1 @@
-Subproject commit cc10bd492affb033b68d3b8f4cb1d8c9d554f995
+Subproject commit fc149c80771705b894d7a1dac427ce112c3c48b6

diff --git a/docs/submodules/sfc b/docs/submodules/sfc
index 83f6c39..77102ae 160000 (submodule)
--- a/docs/submodules/sfc
+++ b/docs/submodules/sfc
@@ -1 +1 @@
-Subproject commit 83f6c393d31ed6bb0105380c8c158f4a724189ce
+Subproject commit 77102aeec40478c078acb616bf65c9d978572401

diff --git a/docs/submodules/snaps b/docs/submodules/snaps
index 9d5a173..bf07de8 160000 (submodule)
--- a/docs/submodules/snaps
+++ b/docs/submodules/snaps
@@ -1 +1 @@
-Subproject commit 9d5a173d158af529169f948b06dd80cd62a99d3e
+Subproject commit bf07de830d7517f7173a3e8a68e1fa6dac2539da

diff --git a/docs/submodules/stor4nfv b/docs/submodules/stor4nfv
index 6bc7e08..957abb6 160000 (submodule)
--- a/docs/submodules/stor4nfv
+++ b/docs/submodules/stor4nfv
@@ -1 +1 @@
-Subproject commit 6bc7e08cc5d80941c80e8d36d3a2b1373f147a05
+Subproject commit 957abb60ddc82354234687328460147e19607caf

diff --git a/docs/submodules/storperf b/docs/submodules/storperf
index ce8adaf..fbdded2 160000 (submodule)
--- a/docs/submodules/storperf
+++ b/docs/submodules/storperf
@@ -1 +1 @@
-Subproject commit ce8adafbccb4bc37930f95561fa24874906013ad
+Subproject commit fbdded2f8141d68c81c5d72a11ab3a9b121c3181

diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf
index 50658b8..be271ae 160000 (submodule)
--- a/docs/submodules/vswitchperf
+++ b/docs/submodules/vswitchperf
@@ -1 +1 @@
-Subproject commit 50658b85db1d848ab1ebfa7daaac8ce479c793b4
+Subproject commit be271aef854887fce72d821a8589dfd4ebbe8e1d

diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick
index 6719224..ba5986d 160000 (submodule)
--- a/docs/submodules/yardstick
+++ b/docs/submodules/yardstick
@@ -1 +1 @@
-Subproject commit 6719224ad22d616cb0dbae2fcc47873acfc6dbf4
+Subproject commit ba5986d99f43b2af5f1c6ea399f59c03352b32c0