Merge pull request #1291 from stackhpc/2023.1-ci-docs

2023.1: add docs on testing, CI & automation
stackhpc · Sep 19, 2024 · f7b7b4e · f7b7b4e
2 parents c99bd0b + 778bfd2
commit f7b7b4e
Show file tree

Hide file tree

Showing 5 changed files with 442 additions and 0 deletions.
diff --git a/doc/source/contributor/environments/ci-aio.rst b/doc/source/contributor/environments/ci-aio.rst
@@ -10,6 +10,11 @@ automates the manual setup steps below, and is recommended for most users.
 The manual setup steps are provided for reference, and for users who wish to
 make changes to the setup process.
 
+.. seealso::
+
+   All-in-one GitHub CI testing using this environment is described :ref:`here
+   <testing-ci-aio>`.
+
 Prerequisites
 =============
 

diff --git a/doc/source/contributor/environments/ci-builder.rst b/doc/source/contributor/environments/ci-builder.rst
@@ -11,6 +11,16 @@ In general it is preferable to use the `container image build CI workflow
 to build container images, but this manual approach may be useful in some
 cases.
 
+.. seealso::
+
+   A container image build GitHub Actions workflow using this environment is
+   described :ref:`here <testing-container-images>`.
+
+.. seealso::
+
+   An overcloud host image build GitHub Actions workflow using this environment
+   is described :ref:`here <testing-host-images>`.
+
 Prerequisites
 =============
 

diff --git a/doc/source/contributor/environments/ci-multinode.rst b/doc/source/contributor/environments/ci-multinode.rst
@@ -14,6 +14,11 @@ beyond the defaults. This includes:
 * Magnum
 * Wazuh
 
+.. seealso::
+
+   On-demand and nightly GitHub Actions workflows workflow using this
+   environment are described :ref:`here <testing-multinode>`.
+
 Manila
 ======
 The Multinode environment supports Manila with the CephFS native backend, but it

diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
@@ -12,3 +12,4 @@ This guide is for contributors of the StackHPC Kayobe configuration project.
    environments/index
    package-updates
    pre-commit
+   testing-ci-automation