starlingx/docs
Code Issues Proposed changes

Fix variable markup (r6,r7,r8,dsR7,dsR8)

Browse Source 
Documentation imported from XML incorrectly wrapped variable names in double
braces such as <<varname>>, instead of <varname>. This review corrects these
instances.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I70cb7e4030a92b3bc83c7b01a6f4135f9cb0e5ad
This commit is contained in:
Ron Stone
2023-03-14 14:26:49 +00:00
parent 3623ff2cd9
commit 39e3de7291
7 changed files with 10 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/dist_cloud/kubernetes/creating-subcloud-groups.rst
View File

@@ -57,7 +57,7 @@ Deletes subcloud group details from the database.
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ dcmanager subcloud-group add --name <<group>> ~(keystone_admin)]$ dcmanager subcloud-group add --name <group>
usage: dcmanager subcloud-group add [-h] [-f {json,shell,table,value,yaml}] usage: dcmanager subcloud-group add [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [-c COLUMN] [--max-width <integer>]
[--fit-width] [--print-empty] [--noindent] [--fit-width] [--print-empty] [--noindent]

4
doc/source/dist_cloud/kubernetes/failure-during-the-installation-or-data-migration-of-n-plus-1-load-on-a-subcloud.rst
View File

@@ -31,7 +31,7 @@ command to fix it.
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ dcmanager subcloud update <<subcloud-name>> --install-values <<subcloud-install-values-yaml>> ~(keystone_admin)]$ dcmanager subcloud update <subcloud-name> --install-values <subcloud-install-values-yaml>
This type of failure is recoverable and you can retry the orchestrated This type of failure is recoverable and you can retry the orchestrated
upgrade for each of the failed subclouds using the following procedure: upgrade for each of the failed subclouds using the following procedure:
@@ -50,7 +50,7 @@ upgrade for each of the failed subclouds using the following procedure:
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ dcmanager upgrade-strategy create <<subcloud-name>> --force <<additional options>> ~(keystone_admin)]$ dcmanager upgrade-strategy create <subcloud-name> --force <additional options>
.. note:: .. note::

2
doc/source/dist_cloud/kubernetes/failure-prior-to-the-installation-of-n-plus-1-load-on-a-subcloud.rst
View File

@@ -41,7 +41,7 @@ orchestrated upgrade after addressing the cause of failure:
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ dcmanager upgrade-strategy create <<additional options>> ~(keystone_admin)]$ dcmanager upgrade-strategy create <additional options>
.. note:: .. note::

2
doc/source/dist_cloud/kubernetes/managing-subclouds-using-the-cli.rst
View File

@@ -133,7 +133,7 @@ fails, delete subclouds, and monitor or change the managed status of subclouds.
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ dcmanager subcloud reconfig <subcloud-id/name> --deploy-config \ ~(keystone_admin)]$ dcmanager subcloud reconfig <subcloud-id/name> --deploy-config \
<filepath> --sysadmin-password <<password>> <filepath> --sysadmin-password <password>
where ``--deploy-config`` must reference the deployment configuration file. where ``--deploy-config`` must reference the deployment configuration file.

4
doc/source/storage/openstack/config-and-management-ceph-placement-group-number-dimensioning-for-storage-cluster.rst
View File

@@ -207,11 +207,11 @@ To delete a pool, use the following command:
.. code-block:: none .. code-block:: none
~(keystone_admin)$ ceph osd pool delete <pool-name> <<pool-name>> ~(keystone_admin)$ ceph osd pool delete <pool-name> <pool-name>
To create a pool, use the parameters from ceph osd dump, and run the following command: To create a pool, use the parameters from ceph osd dump, and run the following command:
.. code-block:: none .. code-block:: none
~(keystone_admin)$ ceph osd pool create {pool-name}{pg-num} {pgp-num} {replicated} <<crush-ruleset-name>> ~(keystone_admin)$ ceph osd pool create {pool-name}{pg-num} {pgp-num} {replicated} <crush-ruleset-name>

4
doc/source/storage/openstack/configure-an-optional-cinder-file-system.rst
View File

@@ -59,7 +59,7 @@ Adding a New Filesystem for Image-Conversion
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ system host-fs-add <<hostname or id>> <<fs-name=size>> ~(keystone_admin)]$ system host-fs-add <hostname or id> <fs-name=size>
Where: Where:
@@ -143,7 +143,7 @@ Removing the File System
.. code-block:: none .. code-block:: none
~(keystone_admin)]$ system host-fs-delete <<hostname or id>> <<fs-name>> ~(keystone_admin)]$ system host-fs-delete <hostname-or-id> <fs-name>
#. When the **image-conversion** file system is removed from the system, the #. When the **image-conversion** file system is removed from the system, the
/opt/conversion partition is also removed. /opt/conversion partition is also removed.

2
doc/source/storage/openstack/storage-configuring-and-management-storage-related-cli-commands.rst
View File

@@ -114,7 +114,7 @@ You can use this command to obtain information about a Glance image.
.. code-block:: none .. code-block:: none
~(keystone_admin)$ OS_AUTH_URL=http://keystone.openstack.svc.cluster.local/v3 ~(keystone_admin)$ OS_AUTH_URL=http://keystone.openstack.svc.cluster.local/v3
~(keystone_admin)$ openstack image-show <<image-id>> ~(keystone_admin)$ openstack image-show <image-id>
+------------------+--------------------------------------+ +------------------+--------------------------------------+
| Property | Value | | Property | Value |
+------------------+--------------------------------------+ +------------------+--------------------------------------+