From a031fd772ed856f81f57f815e204d46566cbc200 Mon Sep 17 00:00:00 2001
From: Andreas Jaeger <aj@suse.com>
Date: Thu, 15 Aug 2019 06:24:32 +0200
Subject: [PATCH] Publish to publish-docs/html

Publish to publish-docs/html to simplify our doc building and publishing
CI jobs.

Change-Id: I8beb68195a7beaa3f2c125ef83db0fa589837639
---
 bin/doc-tools-build-rst                               | 8 ++++----
 bin/doc-tools-check-languages                         | 4 ++--
 doc/source/man/openstack-doc-test.rst                 | 2 +-
 releasenotes/notes/publish-docs-54aa1604f102cb7c.yaml | 4 ++++
 4 files changed, 11 insertions(+), 7 deletions(-)
 create mode 100644 releasenotes/notes/publish-docs-54aa1604f102cb7c.yaml

diff --git a/bin/doc-tools-build-rst b/bin/doc-tools-build-rst
index c6a7a59d..acf43132 100755
--- a/bin/doc-tools-build-rst
+++ b/bin/doc-tools-build-rst
@@ -18,7 +18,7 @@ if [ -z "$DIRECTORY" ] ; then
     echo "usage $0 DIRECTORY options"
     echo "Options are:"
     echo "--tag TAG: Use given tag for building"
-    echo "--target TARGET: Copy files to publish-docs/$TARGET"
+    echo "--target TARGET: Copy files to publish-docs/html/$TARGET"
     echo "--build BUILD: Name of build directory"
     echo "--linkcheck: Check validity of links instead of building"
     echo "--pdf: PDF file generation"
@@ -105,9 +105,9 @@ else
 
     # Copy RST (and PDF)
     if [ "$TARGET" != "" ] ; then
-        mkdir -p publish-docs/$TARGET
-        rsync -a $BUILD_DIR/ publish-docs/$TARGET/
+        mkdir -p publish-docs/html/$TARGET
+        rsync -a $BUILD_DIR/ publish-docs/html/$TARGET/
         # Remove unneeded build artefact
-        rm -f publish-docs/$TARGET/.buildinfo
+        rm -f publish-docs/html/$TARGET/.buildinfo
     fi
 fi
diff --git a/bin/doc-tools-check-languages b/bin/doc-tools-check-languages
index 5ca7fc7a..479f196f 100755
--- a/bin/doc-tools-check-languages
+++ b/bin/doc-tools-check-languages
@@ -96,7 +96,7 @@ function build_rst {
                 -d ${DOCTREES} \
                 ${DOC_DIR}${book}/source/ \
                 ${BUILD_DIR}
-            PUBLISH_DIR=publish-docs/${language}/${book}-${tag}
+            PUBLISH_DIR=publish-docs/html/${language}/${book}-${tag}
             mkdir -p ${PUBLISH_DIR}
             rsync -a ${DOC_DIR}${book}/build-${tag}/html/ ${PUBLISH_DIR}
             echo $MARKER_TEXT > ${PUBLISH_DIR}/.root-marker
@@ -109,7 +109,7 @@ function build_rst {
             -d ${DOCTREES} \
             ${DOC_DIR}${book}/source/ \
             ${BUILD_DIR}
-        PUBLISH_DIR=publish-docs/${language}/${book}/
+        PUBLISH_DIR=publish-docs/html/${language}/${book}/
         mkdir -p ${PUBLISH_DIR}
         rsync -a ${DOC_DIR}${book}/build/html/ ${PUBLISH_DIR}
         echo $MARKER_TEXT > ${PUBLISH_DIR}/.root-marker
diff --git a/doc/source/man/openstack-doc-test.rst b/doc/source/man/openstack-doc-test.rst
index f596be2f..6162a8dd 100644
--- a/doc/source/man/openstack-doc-test.rst
+++ b/doc/source/man/openstack-doc-test.rst
@@ -83,7 +83,7 @@ OPTIONS
     check-build.
 
 **--publish**
-    Setup content in publish-docs directory for publishing to
+    Setup content in publish-docs/html directory for publishing to
     external website.
 
 **--verbose**
diff --git a/releasenotes/notes/publish-docs-54aa1604f102cb7c.yaml b/releasenotes/notes/publish-docs-54aa1604f102cb7c.yaml
new file mode 100644
index 00000000..76d05277
--- /dev/null
+++ b/releasenotes/notes/publish-docs-54aa1604f102cb7c.yaml
@@ -0,0 +1,4 @@
+critical:
+  - |
+    Change publishing from `publish-docs` to `publish-docs/html`. This needs
+    changing in build and publish CI jobs.