Add scripts and tasks to publish docs to github pages

.gitignore

@@ -35,4 +35,7 @@ coverage.txt
 test/e2e/e2e\.test
 
 # mkdocs
-/site
+site
+
+# temporal github pages
+gh-pages

.travis.yml

@@ -22,17 +22,18 @@ go:
 
 go_import_path: k8s.io/ingress-nginx
 
-# New secure variables can be added using travis encrypt -r kubernetes/ingress-nginx --add K=V 
+# New secure variables can be added using travis encrypt -r kubernetes/ingress-nginx --add K=V
 env:
   global:
   - CHANGE_MINIKUBE_NONE_USER=true
   - KUBERNETES_VERSION=v1.9.4
   - DOCKER=docker
-  - TRAVIS_TIMEOUT=240
   - BUSTED_VERSION=2.0.rc12
+  - GH_REF=github.com/kubernetes/ingress-nginx
   - secure: LIS2XpZufWTcJ53jiRsSZy2Gi1EUJ1XmLg7z3f2ZHeMnyG2Jhk3GW4vod1FNru+PY4PWgddLdCdIl+jqOYXndFlbdAWF3/Oy5fEkYLXdYV7tdlHcPWDkqNFrfiyZ4guChN+b2Nk6FqU7o5fsZAIR7VAbgqNRF5XMo9Mhn/vhDCQRcnbXy7uq7JTrYUkqDbQoyYvT6b480GCY5gags1zp/xZfPDNZEe936o8i5IPTyiykRyNOXN/AH6kd3pR5e1xYgcvJ9KpSVPghcwFE7kJ4fOVMRhRG5ML+IyML+xD0jX43EMNoqRKZ/HS42kIMCInFbJEcxVde7DPNBZ7Y3GAqh7HO6qrE70Dn3ha6DID6zCoH2ArW39BxG4zempjn2VxYoMRGREyZszWQb++dwGoHmo5FHt6zvIrYBG0dA0H8ja9VkZkjFwtYTGHU1ooPzUfJK4O4VBayV8LqZibyZQR+GrmyQc0aagUY7J/fe4A2PJyI4DbkeZ7GX1ELj0ciDz4urQSzUc8l/T3aU3X+FuJItjgYtMLPmqcjA5uifDCtutE8Z9L2gSpanqUdvLSOozuxPho/KNl+2YlF7fXqPW3LnRf5mHD+NbOff306pvKlHJOb2Vmth+HBQ1XDzt/Cy5+sfwS3E0Vmh6UTq/NtkUXxwH10BDMF7FMVlQ4zdHQvyZ0=
   - secure: rKDoy9IYYYy0fYBs4+9mwuBVq/TcxfFwMfE0ywYWhUUdgzrUYSJAwpoe/96EQ4YmESUefwC2nDNq4G3XzJKYOWf83PaIveb9Z//zmMrCQXjDuDBDLpwV3sXSh7evXiVDohJz4ogBCeMRUCMKYsyKBM9yWfa/iu+yI92dbphpK9peOKW6yBc0uspJlln4swN3GS2WT9LVuPY2Azv9U2UqrXufOPDKG/qEb/Vrn4yZ2lR/50r2k45e9nSvDoByvr10V8ubM5Zc0iP0vBuAUVRdByv6N53Q4gaBGapY6SxhIjIPC/h0rNnuT9EXp7MWaPT5FmBxLt9wnyleT9QhZJnFyaBYqFgcz/DKifYQkryY4M5dLMo/Rt3yATyAy8Y0df1TOoV2dKdqwOOwQ8bXB1wDfyrGxmQj9HY4Ffnphx3wPE1a+Sjuh+S5Epm7XJbPx5pZJqNO2hd4sTbk0Xp3gpPbihny2r/jtNwHl0wpFCfOM68RNrsVRlIwG3UhzbZvblbQ/M/mmWCdgzINjt07I2SGCJxfKG0e98Q49SKUoDoOgQTTRDqTC9IgOEDxyfAkT0Vr6BtlP88Nsgnf6kmboyigBrRAiaDQGTxn3SP6LnQI3CeopaRDYvFZe/rTwPXE9XlKoTn9FTWnAqF3MuWaLslDcDKYEh7OaYJjF01piu6g4Nc=
   - secure: qCCk7HIEnOph2q8mQ55MKS2MM0RSpCbwDZx7csF6NHRr5khVRyhg2r8jN0iUW+peoAChRYV91YOnl5v8K49O38IEQpzgADixiLu4VPFcYddwKrtTJF+AGvFGzBKtqDksRuUTqfJ+PdxGnO9iNkS0MFzF1ImSQGp1QfkegC8wSrZF8svAedjNOC9XV+FX0tTyj14eTSy3KUYafIyuhjG+nSjhlQxAI1Tq4EClcTZOzAIYNhkeZ4Gcu1nHPQMTQT5AQgRAhG8i7rNKfghqX8OccKNWUhvFB3eOFFf4dlb02IA2L/b8Fl4NnZpyAWcwF+CBZrzQoFARBE1xIvGfaNa9i6noyrpJ/g+0g7EyKgTsixaQInBmZ7ECVpQkSO+/3leWfwssZs7H4cqy2HeXH6dkE+JUeI0WDjYV7YwdVNoFm8wXszDu+MCQTGXJ4moO4F/jMvY4w+tNo8ISJiNZ/+uQaIlPaijCdwu9FPvAY59lJXORGVHd1Fq2pKkGkNjQVHtu9BH7ufO1fX5a6FtYbclMwm7w9BE5jnJNoP+y8Yq0bVwbGONSUFTyMWCbSCYDsyUPzmaZLkFpZPbnJua5y9c1x0/OYijNizBW0UVQDZauortsTPzwYlZ1J7TywVtpUEoI8CGuUb2QEWh+O/IwrogtiKvFtPrrYakIwV/lr7mO294=
+  - secure: ZZlcwdr4X2ZeIuA4f5wiT04qNCpSiNQb9d3dITG7MdtxIpiC1mi9rUFAkMDDlNjKumHO82O/a/X4RYKjXny7eixeHl5lgQ++IV9APwvWfsCiREFhiQFspfL+j0d9sZ5I4pfyPC671984We1T4G+ltuMcN3nQdPm3mP4xPT3h0IBQ9iAHonKck0TdLieNZ47vPPB8C8oxbx5NpdW8aSfQJGo3bFGiXNxWWFZ4P7BsMBDrBZaXuh0rAml/0nCJBGohgSqC8h/UObBOHeehEWnF1zzfQPRezHwVkUaMf2+xQtLGhB5rPjFhBKX0C/JZeqDgHEQ0auC2bLbfG5QCYQauy7jCq5kc6XPT7xFxCUd/sS7Wu2gg6KcgFeTE+Rnn4KWFZx2jMP2EPQYP2+LrM/VbfY1HW4QkpIkPVSFBatciuePUnIkEX6+jVM+GEZOhOOEqZ89zwjsGpa2GkFAJrwX/dphXXtn6oS20mLbu1kqocWTbGUJl/fYztTxCdOt/NoH/hiQMxy+TOGFF3Dx85MJiMUOlgk/NbPqUwBn5RbuD71L69vFZZLpU09V4PuablWW8ACQxgp8BMeqLhaLRn/I3r0ntRc8AdQ1xubPlrVWO9DDbhGfj44YPNoLUAC/7QHkRyCbP98Yv2FTXrJFcx9isA2viFx2UxzTsvXcAKHbCSAw=
 
 jobs:
   include:
@@ -53,7 +54,7 @@ jobs:
     - make lua-test
   - stage: Coverage
     before_script:
-    # start minikube 
+    # start minikube
     - test/e2e/up.sh
     script:
     - go get github.com/jteeuwen/go-bindata/...
@@ -70,20 +71,24 @@ jobs:
   - stage: publish amd64
     if: type = api AND branch = master AND repo = kubernetes/ingress-nginx
     script:
-    - travis_wait ${TRAVIS_TIMEOUT} .travis/publish.sh amd64
+    - .travis/publish.sh amd64
   - stage: publish arm
     if: type = api AND branch = master AND repo = kubernetes/ingress-nginx
     script:
-    - travis_wait ${TRAVIS_TIMEOUT} .travis/publish.sh arm
+    - .travis/publish.sh arm
   - stage: publish arm64
     if: type = api AND branch = master AND repo = kubernetes/ingress-nginx
     script:
-    - travis_wait ${TRAVIS_TIMEOUT} .travis/publish.sh arm64
+    - .travis/publish.sh arm64
   - stage: publish ppc64le
     if: type = api AND branch = master AND repo = kubernetes/ingress-nginx
     script:
-    - travis_wait ${TRAVIS_TIMEOUT} .travis/publish.sh ppc64le
+    - .travis/publish.sh ppc64le
   - stage: publish s390x
     if: type = api AND branch = master AND repo = kubernetes/ingress-nginx
     script:
-    - travis_wait ${TRAVIS_TIMEOUT} .travis/publish.sh s390x
+    - .travis/publish.sh s390x
+  - stage: Publish docs
+    if: type = api AND branch = master AND repo = kubernetes/ingress-nginx
+    script:
+    - .travis/publish-docs.sh

.travis/publish-docs.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+
+# Copyright 2018 The Kubernetes Authors.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+if ! [ -z $DEBUG ]; then
+  set -x
+fi
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+if [ "$COMPONENT" != "docs" ]; then
+    echo "This task runs only to publish docs"
+    exit 0
+fi
+
+make -C ${DIR}/.. build-docs
+
+git config --global user.email "[email protected]"
+git config --global user.name "Travis Bot"
+
+git clone --branch=gh-pages --depth=1 https://${GH_REF} ${DIR}/gh-pages
+cd ${DIR}/gh-pages
+
+git rm -r .
+
+cp -r ${DIR}/../site/* .
+
+git add .
+git commit -m "Deploy GitHub Pages"
+git push --force --quiet "https://${GH_TOKEN}@${GH_REF}" gh-pages > /dev/null 2>&1

.travis/publish.sh

@@ -16,6 +16,11 @@
 
 DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 
+if [ "$COMPONENT" == "docs" ]; then
+    echo "Skipping because we are publishing docs"
+    exit 0
+fi
+
 if [ $# -eq "1" ]
 then
     export ARCH=$1
@@ -26,11 +31,6 @@ source $DIR/common.sh
 echo "Login to quay.io..."
 docker login --username=$QUAY_USERNAME --password=$QUAY_PASSWORD quay.io >/dev/null 2>&1
 
-if [ $# -eq "1" ]
-then
-    export ARCH=$1
-fi
-
 case "$COMPONENT" in
 "ingress-controller")
     $DIR/ingress-controller.sh

.travis/release-from-travis.sh

@@ -57,7 +57,7 @@ EOF
 }
 
 case "$1" in
-	ingress-controller|nginx)
+	ingress-controller|nginx|docs)
 		publish $TRAVIS_CI_TOKEN $1
 	;;
 	*)

Makefile

@@ -213,3 +213,11 @@ dep-ensure:
 .PHONY: dev-env
 dev-env:
 	@./hack/build-dev-env.sh
+
+.PHONY: live-docs
+live-docs:
+	@docker run --rm -it -p 3000:3000 -v ${PWD}:/docs aledbf/mkdocs:0.1
+
+.PHONY: build-docs
+build-docs:
+	@docker run --rm -it -v ${PWD}:/docs aledbf/mkdocs:0.1 build