From 728a94213177ced69f9f23f14e75ff5f2a52d75f Mon Sep 17 00:00:00 2001
From: Paul Belanger <pabelanger@redhat.com>
Date: Sun, 17 Sep 2017 11:04:41 -0400
Subject: [PATCH] Create build-openstack-sphinx-docs job

Since we don't need docs-draft to be special, we can do this job
here rather than in project-config. The new name will not conflict
with the name in project-config, but also matches the infra-manual
guidelines on job naming (action first)

Change-Id: I08f5e7aab981098ad053e39fbb614bd6d0606fc7
---
 playbooks/openstack-doc-build/post.yaml       |  3 --
 playbooks/sphinx-docs/post.yaml               |  3 ++
 .../run.yaml                                  |  0
 zuul.yaml                                     | 31 ++++++++++++-------
 4 files changed, 22 insertions(+), 15 deletions(-)
 delete mode 100644 playbooks/openstack-doc-build/post.yaml
 create mode 100644 playbooks/sphinx-docs/post.yaml
 rename playbooks/{openstack-doc-build => sphinx-docs}/run.yaml (100%)

diff --git a/playbooks/openstack-doc-build/post.yaml b/playbooks/openstack-doc-build/post.yaml
deleted file mode 100644
index 9dfb9fc6..00000000
--- a/playbooks/openstack-doc-build/post.yaml
+++ /dev/null
@@ -1,3 +0,0 @@
-- hosts: all
-  roles:
-    - prepare-infra-docs-for-afs
diff --git a/playbooks/sphinx-docs/post.yaml b/playbooks/sphinx-docs/post.yaml
new file mode 100644
index 00000000..61a111e9
--- /dev/null
+++ b/playbooks/sphinx-docs/post.yaml
@@ -0,0 +1,3 @@
+- hosts: all
+  roles:
+    - prepare-docs-for-afs
diff --git a/playbooks/openstack-doc-build/run.yaml b/playbooks/sphinx-docs/run.yaml
similarity index 100%
rename from playbooks/openstack-doc-build/run.yaml
rename to playbooks/sphinx-docs/run.yaml
diff --git a/zuul.yaml b/zuul.yaml
index 61cd8b18..3f8747c6 100644
--- a/zuul.yaml
+++ b/zuul.yaml
@@ -44,17 +44,24 @@
     nodes: ubuntu-xenial
 
 - job:
-    name: openstack-doc-build-to-move
+    name: build-openstack-sphinx-docs
     parent: tox-docs
-    run: playbooks/openstack-doc-build/run
-    post-run: playbooks/openstack-doc-build/post
+    description: |
+      Builds docuemtation using Sphinx per the OpenStack PTI and then
+      collects the results into the log directory so that they can be
+      examined in their published form after a successful build.
+      It runs the prepare-docs-for-afs role so that AFS stamp files
+      can be examined if desired, and also validates htaccess files
+      using the whereto tool.
+    run: playbooks/sphinx-docs/run
+    post-run: playbooks/sphinx-docs/post
+    success-url: html/
     required-projects:
       - name: openstack/requirements
     roles:
       - zuul: openstack-infra/zuul-jobs
     vars:
       tox_constraints_file: "{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt"
-      tox_upper_constraints_file: "{{ ansible_user_dir }}/src/git.openstack.org/openstack/requirements/upper-constraints.txt"
       tox_envlist: venv
       tox_extra_args: -vv python setup.py build_sphinx
 
@@ -344,10 +351,10 @@
     name: publish-openstack-python-docs-infra
     check:
       jobs:
-        - openstack-doc-build-to-move
+        - build-openstack-sphinx-docs
     gate:
       jobs:
-        - openstack-doc-build-to-move
+        - build-openstack-sphinx-docs
     post:
       jobs:
         - publish-openstack-python-docs-infra
@@ -439,12 +446,12 @@
     name: openstack-python-jobs
     check:
       jobs:
-        - openstack-doc-build-to-move
+        - build-openstack-sphinx-docs
         - openstack-tox-pep8
         - openstack-tox-py27
     gate:
       jobs:
-        - openstack-doc-build-to-move
+        - build-openstack-sphinx-docs
         - openstack-tox-pep8
         - openstack-tox-py27
     post:
@@ -496,7 +503,7 @@
     name: openstack-python-jobs-trusty
     check:
       jobs:
-        - openstack-doc-build-to-move:
+        - build-openstack-sphinx-docs:
             nodes: ubuntu-trusty
         - openstack-tox-pep8:
             nodes: ubuntu-trusty
@@ -504,7 +511,7 @@
             nodes: ubuntu-trusty
     gate:
       jobs:
-        - openstack-doc-build-to-move:
+        - build-openstack-sphinx-docs:
             nodes: ubuntu-trusty
         - openstack-tox-pep8:
             nodes: ubuntu-trusty
@@ -534,7 +541,7 @@
         - base-integration-ubuntu-trusty
         - base-integration-ubuntu-xenial
         - base-integration-opensuse423
-        - openstack-doc-build-to-move
+        - build-openstack-sphinx-docs
         - tox-linters
     gate:
       jobs:
@@ -543,5 +550,5 @@
         - base-integration-ubuntu-trusty
         - base-integration-ubuntu-xenial
         - base-integration-opensuse423
-        - openstack-doc-build-to-move
+        - build-openstack-sphinx-docs
         - tox-linters