starlingx/docs
Code Issues Proposed changes

Fix escaped underscores (r5,r6,dsR6)

Browse Source 
Imported DITA files contain escaped underscores in literal contexts
that are passed to output as is, resulting in inaccurate content.
This review cleans up instances based on grep of HTML output.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I63a8675e6199461b4ee9694e44cd6fd1db12f788
This commit is contained in:
Ron Stone 2022-06-08 10:47:55 -04:00
parent a97ce646d9
commit 7014f65e69
3 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/backup/kubernetes/system-backup-running-ansible-restore-playbook-remotely.rst
View File

@ -78,7 +78,7 @@ In this method you can run Ansible Restore playbook and point to controller-0.
.. code-block:: none
-e backup\_filename= localhost_platform_backup_2019_07_15_14_46_37.tgz
-e backup_filename= localhost_platform_backup_2019_07_15_14_46_37.tgz
- The initial_backup_dir is the location on the Ansible control
machine where the platform backup tar file is placed to restore the

16
doc/source/fault-mgmt/kubernetes/viewing-active-alarms-using-the-cli.rst
View File

@ -64,27 +64,27 @@ To review detailed information about a specific alarm instance, see
| | |
| | ~(keystone_admin)$ fm alarm-list --query uuid=4ab5698a-19cb... |
+-----------------------------------------------------+----------------------------------------------------------------------------+
| :command:`alarm\_id=<alarm id\>` | Query alarms by alarm ID, for example: |
| :command:`alarm_id=<alarm id\>` | Query alarms by alarm ID, for example: |
| | |
| | .. code-block:: none |
| | |
| | ~(keystone_admin)$ fm alarm-list --query alarm_id=100.104 |
+-----------------------------------------------------+----------------------------------------------------------------------------+
| :command:`alarm\_type=<type\>` | Query alarms by type, for example: |
| :command:`alarm_type=<type\>` | Query alarms by type, for example: |
| | |
| | .. code-block:: none |
| | |
| | ~(keystone_admin)$ fm alarm-list --query \ |
| | alarm_type=operational-violation |
+-----------------------------------------------------+----------------------------------------------------------------------------+
| :command:`entity\_type\_id=<type id\>` | Query alarms by entity type ID, for example: |
| :command:`entity_type_id=<type id\>` | Query alarms by entity type ID, for example: |
| | |
| | .. code-block:: none |
| | |
| | ~(keystone_admin)$ fm alarm-list --query \ |
| | entity_type_id=system.host |
+-----------------------------------------------------+----------------------------------------------------------------------------+
| :command:`entity\_instance\_id=<instance id\>` | Query alarms by entity instance id, for example: |
| :command:`entity_instance_id=<instance id\>` | Query alarms by entity instance id, for example: |
| | |
| | .. code-block:: none |
| | |
@ -117,17 +117,17 @@ To review detailed information about a specific alarm instance, see
UUID can be used in display alarm details with the
:command:`fm alarm-show` <UUID> command.
**--include\_suppress**
**--include_suppress**
Use this option to include suppressed alarms in the list.
**--mgmt\_affecting**
**--mgmt_affecting**
Management affecting alarms prevent some critical administrative
actions from being performed. For example, software upgrades. Using the
``--mgmt\_affecting`` option will list an additional column in the output,
``--mgmt_affecting`` option will list an additional column in the output,
'Management Affecting', which indicates whether the alarm is management
affecting or not.
**--degrade\_affecting**
**--degrade_affecting**
Include degrade affecting status in output.
The following example shows alarm UUIDs.

4
doc/source/system_configuration/openstack/system-configuration-overview.rst
View File

@ -89,11 +89,11 @@ The optional arguments are:
``--reset-values``
Replace any existing helm chart overrides with the ones specified.
``--values <file\_name>``
``--values <file_name>``
Specify a YAML file containing helm chart override values. Can specify
multiple times.
``--set <commandline\_overrides>``
``--set <commandline_overrides>``
Set helm chart override values on the command line. Multiple override
values can be specified with multiple ``--set`` arguments. These are
processed after ``--values`` files.