Skip to content

Cherry pick fix broken links to 2023.1 #1558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 4, 2025
Merged

Cherry pick fix broken links to 2023.1 #1558

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
acee0c8
Fix broken upstream doc link
technowhizz Mar 4, 2025
d3f338e
Ensure all Kayobe, Kolla & Kolla Ansible docs links use extlinks
technowhizz Mar 4, 2025
745faa7
Remove extra '/' at the end of links
technowhizz Mar 4, 2025
e82adff
Add reno
technowhizz Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions doc/source/configuration/cephadm.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,8 +208,8 @@ Pools
~~~~~

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

.. code:: yaml
Expand All @@ -236,8 +236,8 @@ Keys
~~~~

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

.. code:: yaml
Expand Down Expand Up @@ -353,7 +353,7 @@ RADOS Gateways

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

RADOS Gateways (RGWs) are defined with the following:

Expand Down
2 changes: 1 addition & 1 deletion doc/source/configuration/ci-cd.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://docs.openstack.org/kayobe/latest/configuration/reference/infra-vms.html>`__ documentation for additional configuration and steps.
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.

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

Expand Down
4 changes: 2 additions & 2 deletions doc/source/configuration/cloudkitty.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://docs.openstack.org/kolla-ansible/latest/reference/rating/cloudkitty-guide.html>`__
how to do this. Also, see the :kolla-ansible-doc:`Kolla Ansible docs on CloudKitty
<reference/rating/cloudkitty-guide.html>`
for more details.

Enable CloudKitty and disable InfluxDB, as we are using OpenSearch as the
Expand Down
4 changes: 2 additions & 2 deletions doc/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
4 changes: 4 additions & 0 deletions releasenotes/notes/fix-broken-links-150bf2dd009123d1.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
fixes:
- |
Fix some broken links in the docs.
Loading