From 2722ae661540d41cea406f31d26049588d752ac4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elisamara=20Aoki=20Gon=C3=A7alves?= Date: Mon, 31 Mar 2025 19:23:18 +0000 Subject: [PATCH] Fix links and titles in Openstack MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fix broken links and changed generic "Overview" titles. Change-Id: I6a44190a39c9ffa231f1c4b80a0e051ea352e677 Signed-off-by: Elisamara Aoki Gonçalves --- doc/source/_vendor/rl-strings.txt | 8 ++++---- .../openstack/node-management-overview.rst | 6 +++--- .../index-planning-kub-913bd621ac0f.rst | 2 ++ .../openstack/ethernet-interfaces.rst | 7 +++---- ...an-or-multi-netted-ethernet-interfaces.rst | 6 ++---- .../openstack/os-data-networks-overview.rst | 20 +++++++++---------- .../security/openstack/security-overview.rst | 6 +++--- ...-configuration-and-management-overview.rst | 6 +++--- ...software-updates-and-upgrades-overview.rst | 6 +++--- 9 files changed, 32 insertions(+), 35 deletions(-) diff --git a/doc/source/_vendor/rl-strings.txt b/doc/source/_vendor/rl-strings.txt index 2bf19ae7c..31656fda6 100644 --- a/doc/source/_vendor/rl-strings.txt +++ b/doc/source/_vendor/rl-strings.txt @@ -100,7 +100,7 @@ .. |exposing-a-generic-pci-device-using-the-cli| replace:: :ref:`Expose a Generic PCI Device Using the CLI ` .. |sr-iov-encryption-acceleration| replace:: :ref:`SR-IOV Encryption Acceleration ` .. |generic-pci-passthrough| replace:: :ref:`Generic PCI Passthrough ` -.. |node-management-overview| replace:: :ref:`Overview ` +.. |node-management-overview| replace:: :ref:`Add OpenStack Compute Node Overview ` .. |configure-pci-passthrough-ethernet-interfaces| replace:: :ref:`Configure PCI Passthrough Ethernet Interfaces ` .. |pci-sr-iov-ethernet-interface-devices| replace:: :ref:`Configure PCI SR-IOV Ethernet Interface Devices ` .. |pci-passthrough-ethernet-interface-devices| replace:: :ref:`PCI Passthrough Ethernet Interface Devices ` @@ -227,7 +227,7 @@ .. |configuring-cpu-core-assignments| replace:: :ref:`Configure CPU Core Assignments Using Horizon ` .. |changing-the-hyper-threading-status| replace:: :ref:`Change the Hyper-threading Status ` .. |configure-intel-e810-nics-using-intel-ethernet-operator| replace:: :ref:`Configure Intel E810 NICs using Intel Ethernet Operator ` -.. |security-overview| replace:: :ref:`Overview ` +.. |security-overview| replace:: :ref:`Security Overview ` .. |install-a-trusted-ca-certificate| replace:: :ref:`Install a Trusted CA Certificate ` .. |config-and-management-using-container-backed-remote-clis-and-clients| replace:: :ref:`Use Container-backed Remote CLIs and Clients ` .. |update-the-domain-name| replace:: :ref:`Update the Domain Name ` @@ -517,7 +517,7 @@ .. |index-sample-flexran-62d77cbb2ed0| replace:: :ref:`Deploy FlexRAN on StarlingX ` .. |deploy-flexran-2203-on-starlingx-1d1b15ecb16f| replace:: :ref:`Deploy FlexRAN 22.03 on StarlingX ` .. |apply-update-to-the-openstack-application| replace:: :ref:`Apply Update to the OpenStack Application ` -.. |software-updates-and-upgrades-overview| replace:: :ref:`Overview ` +.. |software-updates-and-upgrades-overview| replace:: :ref:`Software Updates Overview ` .. |index-updates-e3b970bb69ce| replace:: :ref:`Updates and Upgrades ` .. |about-kubernetes-orchestrated-upgrades| replace:: :ref:`About Kubernetes Version Upgrade Cloud Orchestration ` .. |the-kubernetes-update-orchestration-process| replace:: :ref:`Kubernetes Version Upgrade Cloud Orchestration Overview ` @@ -536,7 +536,7 @@ .. |configure-an-optional-cinder-file-system| replace:: :ref:`Configure the Optional Image Conversion File System ` .. |nova-ephemeral-storage| replace:: :ref:`Nova Ephemeral Storage ` .. |configuration-and-management-storage-on-controller-hosts| replace:: :ref:`Storage on Controller Hosts ` -.. |storage-configuration-and-management-overview| replace:: :ref:`Overview ` +.. |storage-configuration-and-management-overview| replace:: :ref:`Storage Overview ` .. |storage-configuration-and-management-storage-utilization-display| replace:: :ref:`Storage Utilization Display ` .. |storage-on-compute-hosts| replace:: :ref:`Storage on Compute Hosts ` .. |storage-configuration-and-management-storage-resources| replace:: :ref:`Storage Resources ` diff --git a/doc/source/node_management/openstack/node-management-overview.rst b/doc/source/node_management/openstack/node-management-overview.rst index b9567c07b..9c124986e 100644 --- a/doc/source/node_management/openstack/node-management-overview.rst +++ b/doc/source/node_management/openstack/node-management-overview.rst @@ -2,9 +2,9 @@ .. zmd1590003300772 .. _node-management-overview: -======== -Overview -======== +=================================== +Add OpenStack Compute Node Overview +=================================== You can add OpenStack compute nodes to an existing |AIO| Duplex system, and use labels to identify OpenStack Nodes. diff --git a/doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst b/doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst index f54c02126..84c8c3bd4 100644 --- a/doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst +++ b/doc/source/planning/kubernetes/index-planning-kub-913bd621ac0f.rst @@ -138,6 +138,8 @@ Security Features security-hardening-firewall-options isolate-starlingx-internal-cloud-management-network +.. _installation-and-resource-planning: + ********************************** Installation and resource planning ********************************** diff --git a/doc/source/planning/openstack/ethernet-interfaces.rst b/doc/source/planning/openstack/ethernet-interfaces.rst index db90e089b..9024a0cd7 100755 --- a/doc/source/planning/openstack/ethernet-interfaces.rst +++ b/doc/source/planning/openstack/ethernet-interfaces.rst @@ -24,10 +24,9 @@ in a |LAG| group. Ethernet interfaces in a |LAG| group can be attached either to the same L2 switch, or to multiple switches in a redundant configuration. For more -information about L2 switch configurations, see :ref:`L2 Access Switches -`. For information about the different -|LAG| modes, see |node-doc|: :ref:`Link Aggregation Settings -`. +information about L2 switch configurations, see +:ref:`network-planning-l2-access-switches`. For information about the different +|LAG| modes, see |node-doc|: :ref:`link-aggregation-settings`. .. seealso:: diff --git a/doc/source/planning/openstack/network-planning-shared-vlan-or-multi-netted-ethernet-interfaces.rst b/doc/source/planning/openstack/network-planning-shared-vlan-or-multi-netted-ethernet-interfaces.rst index e6c51493c..f38690f83 100755 --- a/doc/source/planning/openstack/network-planning-shared-vlan-or-multi-netted-ethernet-interfaces.rst +++ b/doc/source/planning/openstack/network-planning-shared-vlan-or-multi-netted-ethernet-interfaces.rst @@ -34,9 +34,7 @@ The following arrangements are possible: cluster host networks also implemented on the interface using |VLAN| tagging, and additional interfaces for data networks . -For some typical interface scenarios, see :ref:`Managed Kubernetes Cluster -Hardware Requirements `. +For some typical interface scenarios, see :ref:`hardware-requirements`. For more information about configuring |VLAN| interfaces, see |node-doc|: -:ref:`Configure VLAN Interfaces Using the CLI -`. +:ref:`configuring-vlan-interfaces-using-the-cli`. diff --git a/doc/source/planning/openstack/os-data-networks-overview.rst b/doc/source/planning/openstack/os-data-networks-overview.rst index fe73d25a9..c5d459f55 100755 --- a/doc/source/planning/openstack/os-data-networks-overview.rst +++ b/doc/source/planning/openstack/os-data-networks-overview.rst @@ -2,11 +2,11 @@ .. include:: /_stx-related-links/os-data-networks-overview.rln .. wdq1463583173409 -.. _os-planning-data-networks-overview: +.. _os-data-networks-overview: -======== -Overview -======== +================================== +Virtual or Cloud Networks Overview +================================== Data networks are used to model the L2 Networks that nodes' data, pci-sriov and pci-passthrough interfaces attach to. @@ -26,19 +26,17 @@ Data networks are created at the |prod| level. .. xbooklink VXLAN Data Networks are specific to |prod-os| application and are described in detail in :ref:`VXLAN Data Networks ` . Segmentation ID ranges, for |VLAN| and |VXLAN| data networks, are defined -through OpenStack Neutron commands, see :ref:`Add Segmentation Ranges Using -the CLI `. +through OpenStack Neutron commands, see +:ref:`adding-segmentation-ranges-using-the-cli`. For details on creating data networks and assigning them to node interfaces, see the |datanet-doc| documentation: -- :ref:`Add Data Networks Using the CLI ` +- :ref:`adding-data-networks-using-the-cli` -- :ref:`Assign a Data Network to an Interface - ` +- :ref:`assigning-a-data-network-to-an-interface` -- :ref:`Remove a Data Network Using the CLI - ` +- :ref:`removing-a-data-network-using-the-cli` .. only:: partner diff --git a/doc/source/security/openstack/security-overview.rst b/doc/source/security/openstack/security-overview.rst index 3d2870fae..67c0a7cbf 100644 --- a/doc/source/security/openstack/security-overview.rst +++ b/doc/source/security/openstack/security-overview.rst @@ -2,9 +2,9 @@ .. iad1589999522755 .. _security-overview: -======== -Overview -======== +================= +Security Overview +================= |prod-os| is a containerized application running on top of |prod-long|. diff --git a/doc/source/storage/openstack/storage-configuration-and-management-overview.rst b/doc/source/storage/openstack/storage-configuration-and-management-overview.rst index 51d641d7a..74d192f43 100644 --- a/doc/source/storage/openstack/storage-configuration-and-management-overview.rst +++ b/doc/source/storage/openstack/storage-configuration-and-management-overview.rst @@ -2,9 +2,9 @@ .. fxm1589998951395 .. _storage-configuration-and-management-overview: -======== -Overview -======== +================ +Storage Overview +================ |prod-os| is a containerized application running on top of the |prod-long|. diff --git a/doc/source/updates/openstack/software-updates-and-upgrades-overview.rst b/doc/source/updates/openstack/software-updates-and-upgrades-overview.rst index ce4277a4a..9c6547f0e 100644 --- a/doc/source/updates/openstack/software-updates-and-upgrades-overview.rst +++ b/doc/source/updates/openstack/software-updates-and-upgrades-overview.rst @@ -2,9 +2,9 @@ .. dqn1590002648435 .. _software-updates-and-upgrades-overview: -======== -Overview -======== +========================= +Software Updates Overview +========================= The ``system application-update -n |prefix|-openstack -v `` command is used for: