summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--INFO.yaml52
-rw-r--r--docker/Dockerfile23
-rw-r--r--docker/README.md28
-rw-r--r--docker/entrypoint.sh28
-rw-r--r--docs/index.rst1
-rw-r--r--docs/release/release-notes.rst2
-rw-r--r--docs/release/userguide.introduction.rst2
m---------docs/submodules/apex0
m---------docs/submodules/armband0
m---------docs/submodules/auto0
m---------docs/submodules/availability0
m---------docs/submodules/barometer0
m---------docs/submodules/bottlenecks0
m---------docs/submodules/calipso0
m---------docs/submodules/clover0
m---------docs/submodules/compass4nfv0
m---------docs/submodules/container4nfv0
m---------docs/submodules/daisy0
m---------docs/submodules/doctor0
m---------docs/submodules/dovetail0
m---------docs/submodules/fuel0
m---------docs/submodules/functest0
m---------docs/submodules/ipv60
m---------docs/submodules/joid0
m---------docs/submodules/moon0
m---------docs/submodules/nfvbench0
m---------docs/submodules/ovn4nfv0
m---------docs/submodules/parser0
m---------docs/submodules/pharos0
m---------docs/submodules/qtip0
m---------docs/submodules/releng0
m---------docs/submodules/releng-xci0
m---------docs/submodules/samplevnf0
m---------docs/submodules/sdnvpn0
m---------docs/submodules/sfc0
m---------docs/submodules/snaps0
m---------docs/submodules/stor4nfv0
m---------docs/submodules/storperf0
m---------docs/submodules/vswitchperf0
m---------docs/submodules/yardstick0
40 files changed, 136 insertions, 0 deletions
diff --git a/INFO.yaml b/INFO.yaml
new file mode 100644
index 000000000..eb32801bd
--- /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
index 000000000..fe1ff808a
--- /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
index 000000000..c7b119c1b
--- /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
index 000000000..6982bffa2
--- /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 b12470bfb..191153f97 100644
--- 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 3fe891a59..8aad8a4d6 100644
--- 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 02267ea80..75c5366f9 100644
--- 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
-Subproject 29367db39d60da9ba839e0ee2254b164fd43e2a
+Subproject 0cd3c6cef32adb1bf9d26414ed73bd9373b0c40
diff --git a/docs/submodules/armband b/docs/submodules/armband
-Subproject feb3b54f39d9710e50b9e0a29036d1dd69f4f3c
+Subproject 0d7a1834aea3bde3e27892919ae731b5cdae556
diff --git a/docs/submodules/auto b/docs/submodules/auto
-Subproject e1730ab6e1b355baec45def4f0ed305998895a7
+Subproject c74e914c628819473625c3bfd03d4535e6e64bb
diff --git a/docs/submodules/availability b/docs/submodules/availability
-Subproject 1c2ce630bf5eba741860232b89e67afc2f7cf71
+Subproject c1ee3631b59009ff61450808e2bd33fe1d4b17f
diff --git a/docs/submodules/barometer b/docs/submodules/barometer
-Subproject 6f1d06bd5bce5803611483a69c88c822b391375
+Subproject ed61877e2ba389ada8c4e60160b43e999f23d60
diff --git a/docs/submodules/bottlenecks b/docs/submodules/bottlenecks
-Subproject 7b61cfd2e0c7bed6004f82d11b4cdc37a2e12ca
+Subproject c4a33d033497629b5e0b2ef1b269742eb26b050
diff --git a/docs/submodules/calipso b/docs/submodules/calipso
-Subproject 648a394f7a318443dfd82f790f83a79616c2690
+Subproject 8f3b074fafd2271557a152f43a676abaee6a32e
diff --git a/docs/submodules/clover b/docs/submodules/clover
-Subproject 19852828dbbcf602b39872303a0366626c34ca8
+Subproject 2208c1dbef93cb46e862bb7ce6b6d8e0a754130
diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv
-Subproject cb4d8671693d27b26de34852795782d28046117
+Subproject b69dfdca72868b884a583d15ad70ffd0c991dd5
diff --git a/docs/submodules/container4nfv b/docs/submodules/container4nfv
-Subproject 6535bcca66f3dcee06a454f5b37e499701cc59a
+Subproject 84ce45c8bf6e03f0373d9c46e0a8b7e0b3faa60
diff --git a/docs/submodules/daisy b/docs/submodules/daisy
-Subproject 0f6f12141ae7997713cbab0296038579376b476
+Subproject 6a7ee18538561c772b0bfbc48805e2a2de74a9c
diff --git a/docs/submodules/doctor b/docs/submodules/doctor
-Subproject 0a76b9c6e1303cee5b93795b05c5a9ca115bbd5
+Subproject f06386c6b436a0adce7b96c6a1d59b5d02ed31f
diff --git a/docs/submodules/dovetail b/docs/submodules/dovetail
-Subproject b2c513d028451cc142e1647bf749f245020bf15
+Subproject 71ba21ff906d4104a81442d4712aac13cf4906d
diff --git a/docs/submodules/fuel b/docs/submodules/fuel
-Subproject 9dfa19de4ae2962152c866657c9a2f60f96a179
+Subproject 2d2f59907d578d266e1aa19040314dc15b27c0c
diff --git a/docs/submodules/functest b/docs/submodules/functest
-Subproject a51e1ca848bd3044e928855650eef4dd4bbaced
+Subproject e521f245ee0575427de49b92506199c6316bb29
diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6
-Subproject d85b9104619fe3477eb067a369238dcbdcad857
+Subproject dfcc0745ef76e684593c8284f9dcb81cca2f795
diff --git a/docs/submodules/joid b/docs/submodules/joid
-Subproject 976a5aa1011379c4a82b13f8dde4b76cbec1ba1
+Subproject c0bc95b384aa0e5a398aa35a300081919898d1d
diff --git a/docs/submodules/moon b/docs/submodules/moon
-Subproject 8c4396c505ea245af4a542cf87b185a010484f5
+Subproject 85209d217c85ada8a55487f5c77fb2990ad0c20
diff --git a/docs/submodules/nfvbench b/docs/submodules/nfvbench
-Subproject ca7bc608e72076dba0b9db50b473ab0d0d18c0e
+Subproject 63bab64fe0babc5a198d0a0457c4fb0a58cfe32
diff --git a/docs/submodules/ovn4nfv b/docs/submodules/ovn4nfv
-Subproject e0e7d50a8dbf70117baec66451df7f594a7db23
+Subproject 9623c07f59e059ed0b1cdc6fdfec9c7d9996d88
diff --git a/docs/submodules/parser b/docs/submodules/parser
-Subproject d6c75bcf6eb3dd88a2dee1478236dcf09b73daf
+Subproject cabfeecb3259c5e22488756d91b6f72d27c4c18
diff --git a/docs/submodules/pharos b/docs/submodules/pharos
-Subproject a02c9ccbd8cd58104dacb048833556e209ef21d
+Subproject a3c0456cc14a75e96808505e670d0cab37b30ab
diff --git a/docs/submodules/qtip b/docs/submodules/qtip
-Subproject d601cde6a374d4e5b5138aab4cf4e156df5dbbc
+Subproject 4dccf13a77e11b3a4cd9066eebc0e61d62e0909
diff --git a/docs/submodules/releng b/docs/submodules/releng
-Subproject 112eb0719a5139191e7fd58a1a5b72bcb3a3694
+Subproject 8d84d7d9ac290135804b8ab3f5506e175db8d29
diff --git a/docs/submodules/releng-xci b/docs/submodules/releng-xci
-Subproject c5d83347c1550efe2e7eb4e114ac2fc0a18f6e6
+Subproject a4866825aafc744e861a3badb86df314bbf22f3
diff --git a/docs/submodules/samplevnf b/docs/submodules/samplevnf
-Subproject a3fc5b620eec70c9e2c043a66d0b358c29d5110
+Subproject 3981ce6fed44db09af235100526ab8bc1666e38
diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn
-Subproject cc10bd492affb033b68d3b8f4cb1d8c9d554f99
+Subproject fc149c80771705b894d7a1dac427ce112c3c48b
diff --git a/docs/submodules/sfc b/docs/submodules/sfc
-Subproject 83f6c393d31ed6bb0105380c8c158f4a724189c
+Subproject 77102aeec40478c078acb616bf65c9d97857240
diff --git a/docs/submodules/snaps b/docs/submodules/snaps
-Subproject 9d5a173d158af529169f948b06dd80cd62a99d3
+Subproject bf07de830d7517f7173a3e8a68e1fa6dac2539d
diff --git a/docs/submodules/stor4nfv b/docs/submodules/stor4nfv
-Subproject 6bc7e08cc5d80941c80e8d36d3a2b1373f147a0
+Subproject 957abb60ddc82354234687328460147e19607ca
diff --git a/docs/submodules/storperf b/docs/submodules/storperf
-Subproject ce8adafbccb4bc37930f95561fa24874906013a
+Subproject fbdded2f8141d68c81c5d72a11ab3a9b121c318
diff --git a/docs/submodules/vswitchperf b/docs/submodules/vswitchperf
-Subproject 50658b85db1d848ab1ebfa7daaac8ce479c793b
+Subproject be271aef854887fce72d821a8589dfd4ebbe8e1
diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick
-Subproject 6719224ad22d616cb0dbae2fcc47873acfc6dbf
+Subproject ba5986d99f43b2af5f1c6ea399f59c03352b32c