summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-01-31 18:49:30 +0100
committerChristopher Price <christopher.price@ericsson.com>2016-02-01 11:02:09 +0000
commit145ed01de3d50f82a9ed25ec1421651b8248df63 (patch)
tree53caa93fde2f0ea9920f4bf6540cab30453b04f3
parent00189df66bad2b629bfeda267d540ab10fcd047e (diff)
Updating scripts including composite doc input.
Added functest repo to include validation text in userguide and configguide. Also updated the script based on Ryota's input https://gerrit.opnfv.org/gerrit/8849 Ready to merge although another patch will be needed once the toolchain is in place to continue to integrate content. Change-Id: I4d7adbd174cea29aada99fcdbd42d4c182456739 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com>
-rw-r--r--.gitignore1
-rwxr-xr-xbuild-composite.sh18
-rw-r--r--docs/configguide/post-install.rst1
-rw-r--r--docs/userguide/general-system.rst3
4 files changed, 15 insertions, 8 deletions
diff --git a/.gitignore b/.gitignore
index 33a0451bb..ec376e94f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,5 +1,6 @@
*~
.*.sw?
/docs_build/
+/docs/projects/
/docs_output/
/releng/
diff --git a/build-composite.sh b/build-composite.sh
index 1bc6ed330..5a961cadb 100755
--- a/build-composite.sh
+++ b/build-composite.sh
@@ -7,6 +7,7 @@ set -o xtrace
GIT_CLONE_BASE=${GIT_CLONE_BASE:-ssh://gerrit.opnfv.org:29418}
GERRIT_BRANCH=${GERRIT_BRANCH:-master}
+WORKSPACE=${WORKSPACE:-/tmp}
get_repo_names() {
# NOTE: Not all repositories are ready for the composite docs,
@@ -16,13 +17,16 @@ get_repo_names() {
echo "sdnvpn"
echo "fuel"
echo "joid"
+ echo "functest"
}
git_clone() {
_repo="$1"
- [[ -d "$_repo" ]] && return 0
+ [[ -d "$WORKSPACE/$_repo" ]] && return 0
+ pushd $WORKSPACE
git clone -b $GERRIT_BRANCH --depth 1 --quiet $GIT_CLONE_BASE/$_repo
+ popd
}
git_clone releng
@@ -35,18 +39,16 @@ mkdir -p docs/projects
echo
echo "Cloning repos of participating OPNFV Projects and copying docs"
echo
-mkdir -p docs_build/projects
-pushd docs_build/projects
for repo in $repos; do
echo " $repo ($GERRIT_BRANCH)"
git_clone $repo
- [[ -e $repo/docs ]] || continue
- cp -r $repo/docs ../../docs/projects/$repo
+ [[ -e $WORKSPACE/$repo/docs ]] || continue
+ [[ -e docs/projects/$repo ]] && rm -rf docs/projects/$repo
+ cp -r $WORKSPACE/$repo/docs docs/projects/$repo
done
-popd
# NOTE: Removing index.rst in project repos to reduce number of docs.
-find docs_build/projects -type f -name 'index.rst' -print | xargs -I i rm -f i
+find docs/projects -type f -name 'index.rst' -print | xargs -I i rm -f i
# NOTE: automated link generation is not ready...
#echo
@@ -65,6 +67,6 @@ find docs_build/projects -type f -name 'index.rst' -print | xargs -I i rm -f i
# done
#done
-./releng/utils/docs-build.sh
+$WORKSPACE/releng/utils/docs-build.sh
echo "Done"
diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst
index b63d44aac..88c12067d 100644
--- a/docs/configguide/post-install.rst
+++ b/docs/configguide/post-install.rst
@@ -4,4 +4,5 @@ Post Configuration Activities
This section describes the post configuration activitites that will allow you to validate the success
of your configuration. Further details may be found in the referred project specific documentation.
+.. include:: ../projects/functest/configguide/configguide.rst
.. include:: ../projects/joid/configguide/postinstall.rst
diff --git a/docs/userguide/general-system.rst b/docs/userguide/general-system.rst
index b62d723c9..364fbce32 100644
--- a/docs/userguide/general-system.rst
+++ b/docs/userguide/general-system.rst
@@ -9,3 +9,6 @@ need to perform operations, depending on the scenario deployed and types of acti
.. include:: ./opendaylight.rst
.. include:: ./onos.rst
.. include:: ./ovs.rst
+
+.. include:: ../projects/functest/userguide/description.rst
+.. include:: ../projects/functest/userguide/runfunctest.rst