diff --git a/doc/source/configuration/cephadm.rst b/doc/source/configuration/cephadm.rst index 6f44eb765..3f75fd122 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 @@ -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: diff --git a/doc/source/configuration/ci-cd.rst b/doc/source/configuration/ci-cd.rst index 6e495c2e8..cbb7cf771 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 83f31205f..084fe45e4 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 diff --git a/doc/source/index.rst b/doc/source/index.rst index be1320948..85d3c4697 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: diff --git a/releasenotes/notes/fix-broken-links-dcd128c8e211b2b8.yaml b/releasenotes/notes/fix-broken-links-dcd128c8e211b2b8.yaml new file mode 100644 index 000000000..8d65779e0 --- /dev/null +++ b/releasenotes/notes/fix-broken-links-dcd128c8e211b2b8.yaml @@ -0,0 +1,4 @@ +--- +fixes: + - | + Fix some broken links in the docs.