Skip to content

Commit a6ccad9

Browse files
authored
Fix broken links & ensure all kayobe, kolla & KA docs links use extlinks (#1557)
Fix broken upstream doc links
1 parent 41246e8 commit a6ccad9

File tree

5 files changed

+14
-10
lines changed

5 files changed

+14
-10
lines changed

doc/source/configuration/cephadm.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,8 @@ Pools
204204
~~~~~
205205

206206
The following example pools should be sufficient to work with the
207-
default `external Ceph
208-
configuration <https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html>`__
207+
default :kolla-ansible-doc:`external Ceph
208+
configuration <reference/storage/external-ceph-guide.html>`
209209
for Cinder, Cinder backup, Glance, and Nova in Kolla Ansible.
210210

211211
.. code:: yaml
@@ -232,8 +232,8 @@ Keys
232232
~~~~
233233

234234
The following example keys should be sufficient to work with the default
235-
`external Ceph
236-
configuration <https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html>`__
235+
:kolla-ansible-doc:`external Ceph
236+
configuration <reference/storage/external-ceph-guide.html>`
237237
for Cinder, Cinder backup, Glance, and Nova in Kolla Ansible.
238238

239239
.. code:: yaml
@@ -349,7 +349,7 @@ RADOS Gateways
349349

350350
RADOS Gateway integration is described in the :kolla-ansible-doc:`Kolla Ansible
351351
documentation
352-
<https://docs.openstack.org/kolla-ansible/latest/reference/storage/external-ceph-guide.html#radosgw>`.
352+
<reference/storage/external-ceph-guide.html#radosgw>`.
353353

354354
RADOS Gateways (RGWs) are defined with the following:
355355

doc/source/configuration/ci-cd.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ Runner Deployment
118118
The repository permissions for a fine-grained personal access token should be; :code:`Actions: R/W, Administration: R/W, Metadata: R`
119119
Once the key has been obtained, add it to :code:`secrets.yml` under :code:`secrets_github_access_token`
120120

121-
7. If the host is an actual Infra VM then please refer to upstream `Infrastructure VMs <https://docs.openstack.org/kayobe/latest/configuration/reference/infra-vms.html>`__ documentation for additional configuration and steps.
121+
7. If the host is an actual Infra VM then please refer to upstream :kayobe-doc:`Infrastructure VMs <configuration/reference/infra-vms.html>` documentation for additional configuration and steps.
122122

123123
8. Run :code:`kayobe playbook run ${KAYOBE_CONFIG_PATH}/ansible/deploy-github-runner.yml`
124124

doc/source/configuration/cloudkitty.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ Configuring in kayobe-config
88
By default, CloudKitty uses Gnocchi and Ceilometer as the collector and fetcher
99
backends. Unless the system has a specific reason not to, we recommend instead
1010
using Prometheus as the backend for both. The following instructions explain
11-
how to do this. Also, see the `Kolla Ansible docs on CloudKitty
12-
<https://docs.openstack.org/kolla-ansible/latest/reference/rating/cloudkitty-guide.html>`__
11+
how to do this. Also, see the :kolla-ansible-doc:`Kolla Ansible docs on CloudKitty
12+
<reference/rating/cloudkitty-guide.html>`
1313
for more details.
1414

1515
Enable CloudKitty and disable InfluxDB, as we are using OpenSearch as the

doc/source/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Overview
1212
========
1313

1414
This documentation covers the StackHPC Kayobe configuration. It is intended to
15-
complement, rather than replace, the upstream :kayobe-doc:`Kayobe </>`,
16-
:kolla-doc:`Kolla </>` and :kolla-ansible-doc:`Kolla Ansible </>`
15+
complement, rather than replace, the upstream :kayobe-doc:`Kayobe <>`,
16+
:kolla-doc:`Kolla <>` and :kolla-ansible-doc:`Kolla Ansible<>`
1717
documentation.
1818

1919
The configuration includes various things, such as:
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
fixes:
3+
- |
4+
Fix some broken links in the docs.

0 commit comments

Comments
 (0)