From 8b284b4ccd0f797a4fb9f52f6f3d45c06625b22c Mon Sep 17 00:00:00 2001 From: technowhizz <7688823+technowhizz@users.noreply.github.com> Date: Tue, 4 Mar 2025 11:43:03 +0000 Subject: [PATCH 1/4] Fix broken upstream doc link --- doc/source/configuration/cephadm.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/source/configuration/cephadm.rst b/doc/source/configuration/cephadm.rst index 6f44eb765f..b16f218c8e 100644 --- a/doc/source/configuration/cephadm.rst +++ b/doc/source/configuration/cephadm.rst @@ -349,7 +349,7 @@ RADOS Gateways RADOS Gateway integration is described in the :kolla-ansible-doc:`Kolla Ansible documentation -`. +`. RADOS Gateways (RGWs) are defined with the following: From 0e187b86ae6bf5ba3fd11d0b6bee8d01797e228d Mon Sep 17 00:00:00 2001 From: technowhizz <7688823+technowhizz@users.noreply.github.com> Date: Tue, 4 Mar 2025 11:45:30 +0000 Subject: [PATCH 2/4] Ensure all Kayobe, Kolla & Kolla Ansible docs links use extlinks --- doc/source/configuration/cephadm.rst | 8 ++++---- doc/source/configuration/ci-cd.rst | 2 +- doc/source/configuration/cloudkitty.rst | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/configuration/cephadm.rst b/doc/source/configuration/cephadm.rst index b16f218c8e..3f75fd1224 100644 --- a/doc/source/configuration/cephadm.rst +++ b/doc/source/configuration/cephadm.rst @@ -204,8 +204,8 @@ Pools ~~~~~ The following example pools should be sufficient to work with the -default `external Ceph -configuration `__ +default :kolla-ansible-doc:`external Ceph +configuration ` for Cinder, Cinder backup, Glance, and Nova in Kolla Ansible. .. code:: yaml @@ -232,8 +232,8 @@ Keys ~~~~ The following example keys should be sufficient to work with the default -`external Ceph -configuration `__ +:kolla-ansible-doc:`external Ceph +configuration ` for Cinder, Cinder backup, Glance, and Nova in Kolla Ansible. .. code:: yaml diff --git a/doc/source/configuration/ci-cd.rst b/doc/source/configuration/ci-cd.rst index 6e495c2e81..cbb7cf7711 100644 --- a/doc/source/configuration/ci-cd.rst +++ b/doc/source/configuration/ci-cd.rst @@ -118,7 +118,7 @@ Runner Deployment The repository permissions for a fine-grained personal access token should be; :code:`Actions: R/W, Administration: R/W, Metadata: R` Once the key has been obtained, add it to :code:`secrets.yml` under :code:`secrets_github_access_token` -7. If the host is an actual Infra VM then please refer to upstream `Infrastructure VMs `__ documentation for additional configuration and steps. +7. If the host is an actual Infra VM then please refer to upstream :kayobe-doc:`Infrastructure VMs ` documentation for additional configuration and steps. 8. Run :code:`kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/deploy-github-runner.yml` diff --git a/doc/source/configuration/cloudkitty.rst b/doc/source/configuration/cloudkitty.rst index 83f31205f8..084fe45e46 100644 --- a/doc/source/configuration/cloudkitty.rst +++ b/doc/source/configuration/cloudkitty.rst @@ -8,8 +8,8 @@ Configuring in kayobe-config By default, CloudKitty uses Gnocchi and Ceilometer as the collector and fetcher backends. Unless the system has a specific reason not to, we recommend instead using Prometheus as the backend for both. The following instructions explain -how to do this. Also, see the `Kolla Ansible docs on CloudKitty -`__ +how to do this. Also, see the :kolla-ansible-doc:`Kolla Ansible docs on CloudKitty +` for more details. Enable CloudKitty and disable InfluxDB, as we are using OpenSearch as the From 38822f6b723ff2f87c84dc160fccfd0494e43c39 Mon Sep 17 00:00:00 2001 From: technowhizz <7688823+technowhizz@users.noreply.github.com> Date: Tue, 4 Mar 2025 11:46:53 +0000 Subject: [PATCH 3/4] Remove extra '/' at the end of links --- doc/source/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index be13209488..85d3c4697b 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,8 +12,8 @@ Overview ======== This documentation covers the StackHPC Kayobe configuration. It is intended to -complement, rather than replace, the upstream :kayobe-doc:`Kayobe `, -:kolla-doc:`Kolla ` and :kolla-ansible-doc:`Kolla Ansible ` +complement, rather than replace, the upstream :kayobe-doc:`Kayobe <>`, +:kolla-doc:`Kolla <>` and :kolla-ansible-doc:`Kolla Ansible<>` documentation. The configuration includes various things, such as: From 29dd25b8cca29d8a6cae662fe118089adf356b56 Mon Sep 17 00:00:00 2001 From: technowhizz <7688823+technowhizz@users.noreply.github.com> Date: Tue, 4 Mar 2025 11:48:35 +0000 Subject: [PATCH 4/4] Add reno --- releasenotes/notes/fix-broken-links-dcd128c8e211b2b8.yaml | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 releasenotes/notes/fix-broken-links-dcd128c8e211b2b8.yaml diff --git a/releasenotes/notes/fix-broken-links-dcd128c8e211b2b8.yaml b/releasenotes/notes/fix-broken-links-dcd128c8e211b2b8.yaml new file mode 100644 index 0000000000..8d65779e0d --- /dev/null +++ b/releasenotes/notes/fix-broken-links-dcd128c8e211b2b8.yaml @@ -0,0 +1,4 @@ +--- +fixes: + - | + Fix some broken links in the docs.