From 6a23ad89c630d1956d14f33ead950a64ee9ec4c1 Mon Sep 17 00:00:00 2001 From: Ivan Anfimov Date: Tue, 6 May 2025 22:25:38 +0000 Subject: [PATCH] docs: fix mistakes in documentation Change-Id: I58874215b317b5234c67b5aa8031d7cf617b5fd9 --- doc/source/admin/manage-instances.rst | 5 ++--- doc/source/admin/manage-volumes.rst | 4 ++-- doc/source/admin/sessions.rst | 5 +---- doc/source/admin/set-quotas.rst | 4 ++-- doc/source/user/launch-instances.rst | 2 ++ doc/source/user/log-in.rst | 2 ++ doc/source/user/manage-volumes.rst | 2 ++ 7 files changed, 13 insertions(+), 11 deletions(-) diff --git a/doc/source/admin/manage-instances.rst b/doc/source/admin/manage-instances.rst index a2564ca202..91f7087d0b 100644 --- a/doc/source/admin/manage-instances.rst +++ b/doc/source/admin/manage-instances.rst @@ -8,7 +8,7 @@ create a snapshot from, and migrate instances. You can also view the logs for instances or launch a VNC console for an instance. For information about using the Dashboard to launch instances as an end -user, see the :doc:`OpenStack End User Guide `. +user, see the :ref:`launch-and-manage-instances`. Create instance snapshots ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -29,8 +29,7 @@ Create instance snapshots #. To launch an instance from the snapshot, select the snapshot and click :guilabel:`Launch`. For information about launching - instances, see the - :doc:`OpenStack End User Guide `. + instances, see the :ref:`launch-and-manage-instances`. Control the state of an instance ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/admin/manage-volumes.rst b/doc/source/admin/manage-volumes.rst index 6eca190f64..4a657c37c8 100644 --- a/doc/source/admin/manage-volumes.rst +++ b/doc/source/admin/manage-volumes.rst @@ -6,7 +6,7 @@ Volumes are the Block Storage devices that you attach to instances to enable persistent storage. Users can attach a volume to a running instance or detach a volume and attach it to another instance at any time. For information about using the dashboard to create and manage volumes as an end user, see the -:doc:`OpenStack End User Guide `. +:ref:`create-and-manage-volumes`. As an administrative user, you can manage volumes and volume types for users in various projects. You can create and delete volume types, and you can view @@ -113,7 +113,7 @@ volumes. To see further information and CLI instructions, see `Create an encrypted volume type `__ - in the OpenStack Block Storage Configuration Guide. + in the OpenStack Block Storage (cinder) Configuration Guide. Delete volume types ~~~~~~~~~~~~~~~~~~~ diff --git a/doc/source/admin/sessions.rst b/doc/source/admin/sessions.rst index 2af2ef1168..5230db259b 100644 --- a/doc/source/admin/sessions.rst +++ b/doc/source/admin/sessions.rst @@ -11,10 +11,7 @@ back end. You customize the session back end through the After architecting and implementing the core OpenStack services and other required services, combined with the Dashboard service steps below, users and administrators can use -the OpenStack dashboard. Refer to the -:doc:`OpenStack User Documentation ` -chapter of the OpenStack End User Guide for -further instructions on logging in to the Dashboard. +the OpenStack dashboard. Refer to the :ref:`login-in-dashboard`. The following sections describe the pros and cons of each option as it pertains to deploying the Dashboard. diff --git a/doc/source/admin/set-quotas.rst b/doc/source/admin/set-quotas.rst index def9d788e3..5f25f1add5 100644 --- a/doc/source/admin/set-quotas.rst +++ b/doc/source/admin/set-quotas.rst @@ -118,5 +118,5 @@ Update project quotas The dashboard does not show all possible project quotas. To view and update the quotas for a service, use its - command-line client. See `OpenStack Administrator Guide - `_. + command-line client. See `Manage quotas + `_. diff --git a/doc/source/user/launch-instances.rst b/doc/source/user/launch-instances.rst index 345af37759..15629eef48 100644 --- a/doc/source/user/launch-instances.rst +++ b/doc/source/user/launch-instances.rst @@ -1,3 +1,5 @@ +.. _launch-and-manage-instances: + =========================== Launch and manage instances =========================== diff --git a/doc/source/user/log-in.rst b/doc/source/user/log-in.rst index fe2cadce77..81aef013e6 100644 --- a/doc/source/user/log-in.rst +++ b/doc/source/user/log-in.rst @@ -1,3 +1,5 @@ +.. _login-in-dashboard: + ======================= Log in to the dashboard ======================= diff --git a/doc/source/user/manage-volumes.rst b/doc/source/user/manage-volumes.rst index e2a4bd0d8e..05e1e0a3fd 100644 --- a/doc/source/user/manage-volumes.rst +++ b/doc/source/user/manage-volumes.rst @@ -1,3 +1,5 @@ +.. _create-and-manage-volumes: + ========================= Create and manage volumes =========================