docs: fix for issues when switching between pages using localization

when using ref: - when go to a new page, the language remains the same as the one that was selected earlier and there is no need to change it again.

Change-Id: I50859f777c7cee9828eca8eb47d6d8c53dce9ed1
This commit is contained in:
Ivan Anfimov
2025-05-09 11:59:09 +00:00
parent cedc093337
commit a43889b19b
9 changed files with 28 additions and 27 deletions

View File

@@ -1,3 +1,5 @@
.. _operations-guide:
================
Operations Guide
================
@@ -10,13 +12,12 @@ For information on how to deploy your OpenStack-Ansible cloud, refer to the
instructions on how to deploy the OpenStack packages and
dependencies on your cloud using OpenStack-Ansible.
For user guides, see the :dev_docs:`User Guide <user/index.html>`.
For user guides, see the :ref:`user-guide`.
For information on how to contribute, extend or develop OpenStack-Ansible,
see the :dev_docs:`Developer Documentation <contributors/index.html>`.
For in-depth technical information, see the
:dev_docs:`OpenStack-Ansible Reference <reference/index.html>`.
For in-depth technical information, see the :ref:`reference-guide`.
This guide ranges from first operations to verify your deployment, to
the major upgrades procedures.

View File

@@ -22,8 +22,7 @@ This project does **not** PXE boot hosts. Host setup and lifecycle management
is left to the deployer. This project also requires that bridges are setup
within the hosts to allow the containers to attach to a local bridge for
network access.
See also the :dev_docs:`Container networking
<reference/architecture/container-networking.html>`.
See also the :ref:`container-networking`.
Ansible Usage
~~~~~~~~~~~~~

View File

@@ -1,3 +1,5 @@
.. _reference-guide:
===========================
OpenStack-Ansible Reference
===========================
@@ -10,14 +12,13 @@ For information on how to deploy your OpenStack-Ansible cloud, refer to the
instructions on how to deploy the OpenStack packages and
dependencies on your cloud using OpenStack-Ansible.
For user guides, see the :dev_docs:`User Guide <user/index.html>`.
For user guides, see the :ref:`user-guide`.
For information on how to manage and operate OpenStack-Ansible, see the
see the :dev_docs:`Operations Guide <admin/index.html>`.
For information on how to contribute, extend or develop OpenStack-Ansible,
see the :dev_docs:`Contributors Guide <contributor/index.html>`.
see the :dev_docs:`Developer Documentation <contributors/index.html>`.
.. toctree::
:maxdepth: 1

View File

@@ -27,7 +27,7 @@ Recommended server resources:
* 80GB free disk space on the root partition, or 60GB+ on a blank
secondary disk. Using a secondary disk requires the use of the
``bootstrap_host_data_disk_device`` parameter. Please see
`Building an AIO`_ for more details.
:ref:`building-an-aio` for more details.
* 16GB RAM
It is `possible` to perform AIO builds within a virtual machine for
@@ -37,6 +37,7 @@ nodes for specific roles are recommended.
.. _hardware-assisted virtualization: https://en.wikipedia.org/wiki/Hardware-assisted_virtualization
.. _building-an-aio:
Building an AIO
---------------
@@ -335,7 +336,7 @@ variables sourced from an ``openrc`` file or the newer ``clouds.yaml`` file.
.. __: https://opendev.org/openstack/python-openstackclient
.. __: https://opendev.org/openstack/openstacksdk
.. __: https://opendev.org/openstack/gophercloud
.. __: https://github.com/gophercloud/gophercloud
OpenStack-Ansible provides the ``openstack_openrc`` role for creating these
configuration files as well as a number of utilities such as *openstackclient*.
@@ -453,7 +454,7 @@ dropdown in the top-right corner and select ``OpenStack RC File``.
document.
More information about SSL certificate configuration can be found in the
:doc:`security guide </user/security/ssl-certificates>`.
:ref:`securing-services-with-ssl-certificates`.
Once one of these files have been created, you can use it to interact with your
deployment using most standard clients and libraries. For example, to list
@@ -480,9 +481,8 @@ This is done by executing the following:
# openstack-ansible -e galera_ignore_cluster_state=true galera-install.yml
If this fails to get the database cluster back into a running state, then
please make use of the
`Galera Cluster Recovery </admin/maintenance-tasks.html#galera-cluster-recovery>`_
section in the operations guide.
please make use of the :ref:`galera-cluster-recovery`
section in the :ref:`operations-guide`.
Rebuilding an AIO
-----------------

View File

@@ -1,3 +1,5 @@
.. _user-guide:
==========
User Guide
==========
@@ -16,8 +18,7 @@ see the :dev_docs:`Operations Guide <admin/index.html>`.
For information on how to contribute, extend or develop OpenStack-Ansible,
see the :dev_docs:`Developer Documentation <contributors/index.html>`.
For in-depth technical information, see the
:dev_docs:`OpenStack-Ansible Reference <reference/index.html>`.
For in-depth technical information, see the :ref:`reference-guide`.
.. toctree::
:maxdepth: 1

View File

@@ -250,15 +250,11 @@ For more information on how to properly configure network interface files
and OpenStack-Ansible configuration files for different deployment scenarios,
please refer to the following:
* :dev_docs:`Configuring a test environment
<user/test/example.html>`
* :dev_docs:`Configuring a homogeneous production environment
<user/prod/example.html>`
* :dev_docs:`Using provider network groups for a heterogeneous environment
<user/prod/provnet_groups.html>`
* :ref:`test-environment-example`
* :ref:`production-environment-config`
* :ref:`provider-network-groups-config`
For network agent and container networking toplogies, please refer to the
following:
* :dev_docs:`Container networking architecture
<reference/architecture/container-networking.html>`
* :ref:`container-networking`

View File

@@ -17,7 +17,7 @@ only to hosts that meet the given parameters.
Before reading this document, please review the following scenario:
* :dev_docs:`Production environment <user/prod/example.html>`
* :ref:`production-environment-config`
This example environment has the following characteristics:
@@ -107,8 +107,7 @@ the built-in groups provided by OpenStack-Ansible.
Before creating custom groups, please review the following:
* :dev_docs:`Configuring the inventory
<reference/inventory/configure-inventory.html>`
* :ref:`configuring-inventory`
The following diagram demonstates how a custom group can be used to further
segment hosts:

View File

@@ -1,3 +1,5 @@
.. _securing-services-with-ssl-certificates:
Securing services with SSL certificates
=======================================

View File

@@ -1,3 +1,5 @@
.. _test-environment-example:
========================
Test environment example
========================