Move deploy-guide under docs for translation

At the moment translation jobs [1] upload content to Zanata only
from doc folder [2]. In order to translate and ensure original text
is present in Zanata (Weblate) we either need to modify the
common_translation_update.sh to look in deploy-guide folder,
or need to move deploy-guide under doc folder and continue
building them separately.

With that, we still need to update docstheme-build-translated.sh [3]
to make DOCNAME and DIRECTORY being configurable through
env variables.

[1] e8f27b8f30/zuul.d/projects.yaml (L2705)
[2] f1140fe7ba/roles/prepare-zanata-client/files/common_translation_update.sh (L425-L465)
[3] 49d1eecc98/bin/docstheme-build-translated.sh

Change-Id: Id561df7391f5bdb896534c3ef99d7bd026bedd21
Signed-off-by: Dmitriy Rabotyagov <noonedeadpunk@gmail.com>

doc/source/conf.py

@@ -157,7 +157,7 @@ language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-#exclude_patterns = ['admin/maintenance-tasks/galera.rst']
+exclude_patterns = ['deploy-guide/*']
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.

doc/source/deploy-guide/source/index.rst

@@ -1,3 +1,5 @@
+:orphan:
+
 ==================================
 OpenStack-Ansible Deployment Guide
 ==================================

doc/source/reference/aboutosa.rst

@@ -6,7 +6,7 @@ OpenStack-Ansible (OSA) uses the `Ansible <https://docs.ansible.com/ansible/late
 IT automation engine to deploy an OpenStack environment on
 
 .. raw:: HTML
-    :file: ../../../deploy-guide/source/supported-platforms.html
+    :file: ../deploy-guide/source/supported-platforms.html
 
 For isolation and ease of maintenance, all OpenStack services are installed by
 default from source code into python virtual environments.
@@ -27,7 +27,7 @@ Why choose OpenStack-Ansible?
 * Supports the major Linux distributions
 
   .. raw:: HTML
-      :file: ../../../deploy-guide/source/supported-platforms.html
+      :file: ../deploy-guide/source/supported-platforms.html
 
 * Offers automation for upgrades between major OpenStack releases.
 * Uses OpenStack defaults for each of the project roles, and provides

tox.ini

@@ -44,18 +44,17 @@ commands =
 setenv =
     SPHINX_WARNINGS_TRANS=1
 
-
 [testenv:deploy-guide]
 deps = {[testenv:docs]deps}
-commands = sphinx-build -a -E -W -d deploy-guide/build/doctrees --keep-going -b html deploy-guide/source deploy-guide/build/html
+commands = sphinx-build -a -E -W -d doc/source/deploy-guide/build/doctrees --keep-going -b html doc/source/deploy-guide/source doc/source/deploy-guide/build/html
 
 [testenv:deploy-guide-pdf-docs]
 deps = {[testenv:docs]deps}
 allowlist_externals =
   make
 commands =
-  sphinx-build -W --keep-going -b latex deploy-guide/source deploy-guide/build/pdf
-  make -C deploy-guide/build/pdf
+  sphinx-build -W --keep-going -b latex doc/source/deploy-guide/source doc/source/deploy-guide/build/pdf
+  make -C doc/source/deploy-guide/build/pdf
 
 [testenv:pdf-docs]
 deps = {[testenv:docs]deps}

zuul.d/jobs.yaml

@@ -31,7 +31,6 @@
     irrelevant-files:
       - ^\.git.*
       - ^.*\.(example|md|rst)$
-      - ^deploy-guide/.*
       - ^doc/.*
       - ^releasenotes/.*
       - ^setup\.(cfg|py)$

zuul.d/project-templates.yaml

@@ -342,7 +342,7 @@
         - build-openstack-deploy-guide:
             files: &deploy-guide-triggers
               - .gitreview
-              - ^deploy-guide/.*
+              - ^doc/source/deploy-guide/.*
               - ansible-role-requirements.yml
               - bindep.txt
               - doc/requirements.txt
@@ -351,6 +351,7 @@
             vars: &deploy-guide-vars
               tox_pdf_envlist: deploy-guide-pdf-docs
               tox_skip_pdf: false
+              sphinx_build_dir: doc/source/deploy-guide/build
               sphinx_pdf_files:
                 - "deploy-guide-{{ zuul.project.short_name }}.pdf"
     gate: