From 3be133063dd7bf22adeb44fa4bba52d897918f02 Mon Sep 17 00:00:00 2001
From: Dmitriy Rabotyagov <noonedeadpunk@gmail.com>
Date: Mon, 12 May 2025 14:07:02 +0200
Subject: [PATCH] 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] https://opendev.org/openstack/project-config/src/commit/e8f27b8f30845986b148d5b24c0188e364f751ed/zuul.d/projects.yaml#L2705
[2] https://opendev.org/openstack/openstack-zuul-jobs/src/commit/f1140fe7bab6ac124ebd4d68dee832d26462faec/roles/prepare-zanata-client/files/common_translation_update.sh#L425-L465
[3] https://opendev.org/openstack/openstackdocstheme/src/commit/49d1eecc9893f2999efa3d35dc02e7f7216afc02/bin/docstheme-build-translated.sh

Change-Id: Id561df7391f5bdb896534c3ef99d7bd026bedd21
Signed-off-by: Dmitriy Rabotyagov <noonedeadpunk@gmail.com>
---
 doc/source/conf.py                                  |   2 +-
 .../source/deploy-guide}/source/conf.py             |   0
 .../source/deploy-guide}/source/configure.rst       |   0
 .../source/deploy-guide}/source/deploymenthost.rst  |   0
 .../installation-workflow-configure-deployment.png  | Bin
 .../installation-workflow-deploymenthost.png        | Bin
 .../figures/installation-workflow-overview.png      | Bin
 .../figures/installation-workflow-run-playbooks.png | Bin
 .../figures/installation-workflow-targethosts.png   | Bin
 .../installation-workflow-verify-openstack.png      | Bin
 .../source/figures/installation-workflow.graffle    | Bin
 .../source/deploy-guide}/source/index.rst           |   2 ++
 .../source/deploy-guide}/source/next-steps.rst      |   0
 .../deploy-guide}/source/overview-requirements.rst  |   0
 .../source/deploy-guide}/source/overview.rst        |   0
 .../source/deploy-guide}/source/run-playbooks.rst   |   0
 .../deploy-guide}/source/supported-platforms.html   |   0
 .../source/targethosts-networkconfig.rst            |   0
 .../deploy-guide}/source/targethosts-prepare.rst    |   0
 .../source/deploy-guide}/source/targethosts.rst     |   0
 .../deploy-guide}/source/verify-operation.rst       |   0
 doc/source/reference/aboutosa.rst                   |   4 ++--
 tox.ini                                             |   7 +++----
 zuul.d/jobs.yaml                                    |   1 -
 zuul.d/project-templates.yaml                       |   3 ++-
 25 files changed, 10 insertions(+), 9 deletions(-)
 rename {deploy-guide => doc/source/deploy-guide}/source/conf.py (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/configure.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/deploymenthost.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/figures/installation-workflow-configure-deployment.png (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/figures/installation-workflow-deploymenthost.png (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/figures/installation-workflow-overview.png (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/figures/installation-workflow-run-playbooks.png (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/figures/installation-workflow-targethosts.png (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/figures/installation-workflow-verify-openstack.png (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/figures/installation-workflow.graffle (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/index.rst (99%)
 rename {deploy-guide => doc/source/deploy-guide}/source/next-steps.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/overview-requirements.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/overview.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/run-playbooks.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/supported-platforms.html (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/targethosts-networkconfig.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/targethosts-prepare.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/targethosts.rst (100%)
 rename {deploy-guide => doc/source/deploy-guide}/source/verify-operation.rst (100%)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 742de1c2bc..c5894af233 100644
--- a/doc/source/conf.py
+++ b/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.
diff --git a/deploy-guide/source/conf.py b/doc/source/deploy-guide/source/conf.py
similarity index 100%
rename from deploy-guide/source/conf.py
rename to doc/source/deploy-guide/source/conf.py
diff --git a/deploy-guide/source/configure.rst b/doc/source/deploy-guide/source/configure.rst
similarity index 100%
rename from deploy-guide/source/configure.rst
rename to doc/source/deploy-guide/source/configure.rst
diff --git a/deploy-guide/source/deploymenthost.rst b/doc/source/deploy-guide/source/deploymenthost.rst
similarity index 100%
rename from deploy-guide/source/deploymenthost.rst
rename to doc/source/deploy-guide/source/deploymenthost.rst
diff --git a/deploy-guide/source/figures/installation-workflow-configure-deployment.png b/doc/source/deploy-guide/source/figures/installation-workflow-configure-deployment.png
similarity index 100%
rename from deploy-guide/source/figures/installation-workflow-configure-deployment.png
rename to doc/source/deploy-guide/source/figures/installation-workflow-configure-deployment.png
diff --git a/deploy-guide/source/figures/installation-workflow-deploymenthost.png b/doc/source/deploy-guide/source/figures/installation-workflow-deploymenthost.png
similarity index 100%
rename from deploy-guide/source/figures/installation-workflow-deploymenthost.png
rename to doc/source/deploy-guide/source/figures/installation-workflow-deploymenthost.png
diff --git a/deploy-guide/source/figures/installation-workflow-overview.png b/doc/source/deploy-guide/source/figures/installation-workflow-overview.png
similarity index 100%
rename from deploy-guide/source/figures/installation-workflow-overview.png
rename to doc/source/deploy-guide/source/figures/installation-workflow-overview.png
diff --git a/deploy-guide/source/figures/installation-workflow-run-playbooks.png b/doc/source/deploy-guide/source/figures/installation-workflow-run-playbooks.png
similarity index 100%
rename from deploy-guide/source/figures/installation-workflow-run-playbooks.png
rename to doc/source/deploy-guide/source/figures/installation-workflow-run-playbooks.png
diff --git a/deploy-guide/source/figures/installation-workflow-targethosts.png b/doc/source/deploy-guide/source/figures/installation-workflow-targethosts.png
similarity index 100%
rename from deploy-guide/source/figures/installation-workflow-targethosts.png
rename to doc/source/deploy-guide/source/figures/installation-workflow-targethosts.png
diff --git a/deploy-guide/source/figures/installation-workflow-verify-openstack.png b/doc/source/deploy-guide/source/figures/installation-workflow-verify-openstack.png
similarity index 100%
rename from deploy-guide/source/figures/installation-workflow-verify-openstack.png
rename to doc/source/deploy-guide/source/figures/installation-workflow-verify-openstack.png
diff --git a/deploy-guide/source/figures/installation-workflow.graffle b/doc/source/deploy-guide/source/figures/installation-workflow.graffle
similarity index 100%
rename from deploy-guide/source/figures/installation-workflow.graffle
rename to doc/source/deploy-guide/source/figures/installation-workflow.graffle
diff --git a/deploy-guide/source/index.rst b/doc/source/deploy-guide/source/index.rst
similarity index 99%
rename from deploy-guide/source/index.rst
rename to doc/source/deploy-guide/source/index.rst
index ff42e2b795..4cfb03f2a5 100644
--- a/deploy-guide/source/index.rst
+++ b/doc/source/deploy-guide/source/index.rst
@@ -1,3 +1,5 @@
+:orphan:
+
 ==================================
 OpenStack-Ansible Deployment Guide
 ==================================
diff --git a/deploy-guide/source/next-steps.rst b/doc/source/deploy-guide/source/next-steps.rst
similarity index 100%
rename from deploy-guide/source/next-steps.rst
rename to doc/source/deploy-guide/source/next-steps.rst
diff --git a/deploy-guide/source/overview-requirements.rst b/doc/source/deploy-guide/source/overview-requirements.rst
similarity index 100%
rename from deploy-guide/source/overview-requirements.rst
rename to doc/source/deploy-guide/source/overview-requirements.rst
diff --git a/deploy-guide/source/overview.rst b/doc/source/deploy-guide/source/overview.rst
similarity index 100%
rename from deploy-guide/source/overview.rst
rename to doc/source/deploy-guide/source/overview.rst
diff --git a/deploy-guide/source/run-playbooks.rst b/doc/source/deploy-guide/source/run-playbooks.rst
similarity index 100%
rename from deploy-guide/source/run-playbooks.rst
rename to doc/source/deploy-guide/source/run-playbooks.rst
diff --git a/deploy-guide/source/supported-platforms.html b/doc/source/deploy-guide/source/supported-platforms.html
similarity index 100%
rename from deploy-guide/source/supported-platforms.html
rename to doc/source/deploy-guide/source/supported-platforms.html
diff --git a/deploy-guide/source/targethosts-networkconfig.rst b/doc/source/deploy-guide/source/targethosts-networkconfig.rst
similarity index 100%
rename from deploy-guide/source/targethosts-networkconfig.rst
rename to doc/source/deploy-guide/source/targethosts-networkconfig.rst
diff --git a/deploy-guide/source/targethosts-prepare.rst b/doc/source/deploy-guide/source/targethosts-prepare.rst
similarity index 100%
rename from deploy-guide/source/targethosts-prepare.rst
rename to doc/source/deploy-guide/source/targethosts-prepare.rst
diff --git a/deploy-guide/source/targethosts.rst b/doc/source/deploy-guide/source/targethosts.rst
similarity index 100%
rename from deploy-guide/source/targethosts.rst
rename to doc/source/deploy-guide/source/targethosts.rst
diff --git a/deploy-guide/source/verify-operation.rst b/doc/source/deploy-guide/source/verify-operation.rst
similarity index 100%
rename from deploy-guide/source/verify-operation.rst
rename to doc/source/deploy-guide/source/verify-operation.rst
diff --git a/doc/source/reference/aboutosa.rst b/doc/source/reference/aboutosa.rst
index 1aa0efe65c..6fc0cbb8f8 100644
--- a/doc/source/reference/aboutosa.rst
+++ b/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
diff --git a/tox.ini b/tox.ini
index c7f3febee5..af4ad0b14c 100644
--- a/tox.ini
+++ b/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}
diff --git a/zuul.d/jobs.yaml b/zuul.d/jobs.yaml
index ab86e0145c..d6869575fb 100644
--- a/zuul.d/jobs.yaml
+++ b/zuul.d/jobs.yaml
@@ -31,7 +31,6 @@
     irrelevant-files:
       - ^\.git.*
       - ^.*\.(example|md|rst)$
-      - ^deploy-guide/.*
       - ^doc/.*
       - ^releasenotes/.*
       - ^setup\.(cfg|py)$
diff --git a/zuul.d/project-templates.yaml b/zuul.d/project-templates.yaml
index ea2f79ac82..c629f01b29 100644
--- a/zuul.d/project-templates.yaml
+++ b/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: