starlingx/docs
Code Issues Proposed changes

Share CLI ref intros (r8, r7, r6, dsR8, dsR7, dsR6)

Browse Source 
Break out intro content for each CLI Ref for reusability.
Convert VIM to an abbrev.

Signed-off-by: Ron Stone <ronald.stone@windriver.com>
Change-Id: I7f4ee6f9bd6120ad84b77dfcfeb900bfba362835
This commit is contained in:
Ron Stone 2023-09-25 18:12:39 +00:00
parent 7fccafa129
commit 8d1003e6dc
9 changed files with 58 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/source/cli_ref/dcmanager.rst
View File

@ -2,12 +2,8 @@
dcmanager
=========
:command:`dcmanager` is the command-line interface for the |prod-dc|
Manager APIs. :command:`dcmanager` is applicable only in the `SystemController`
region of the central cloud in a distributed cloud configuration.
This page documents the :command:`dcmanager` command.
.. include:: /shared/_includes/cli-ref-intro-dcmanager.rest
.. contents::
:local:
:depth: 2

4
doc/source/cli_ref/fm.rst
View File

@ -2,9 +2,7 @@
fm
==
:command:`fm` is the command-line interface for Fault Management.
This page documents the :command:`fm` command.
.. include:: /shared/_includes/cli-ref-intro-fm.rest
.. contents::
:local:

5
doc/source/cli_ref/sw-manager.rst
View File

@ -2,10 +2,7 @@
sw-manager
==========
:command:`sw-manager` is the command-line interface for the VIM Orchestration
APIs.
This page documents the :command:`sw-manager` command.
.. include:: /shared/_includes/uline.rest
.. contents::
:local:

5
doc/source/cli_ref/system.rst
View File

@ -2,10 +2,7 @@
system
======
:command:`system` is the command-line interface for System Inventory and
Maintenance.
This page documents the :command:`system` command in |prod|.
.. include:: /shared/_includes/cli-ref-intro-system.rest
.. contents::
:local:

14
doc/source/shared/_includes/cli-ref-intro-dcmanager.rest Normal file
View File

@ -0,0 +1,14 @@
.. include:: /shared/_includes/uline.rest
:command:`dcmanager` is the command-line interface for the |prod-dc|
Manager APIs. :command:`dcmanager` is applicable only in the `SystemController`
region of the central cloud in a distributed cloud configuration.
This page documents the :command:`dcmanager` command.
For a full description of usage and optional arguments for a specific
:command:`dcmanager` command, enter:
.. code-block::
~(keystone_admin)]$ dcmanager help <command>

12
doc/source/shared/_includes/cli-ref-intro-fm.rest Normal file
View File

@ -0,0 +1,12 @@
.. include:: /shared/_includes/uline.rest
:command:`fm` is the command-line interface for Fault Management.
This page documents the :command:`fm` command.
For a full description of usage and optional arguments for a specific
:command:`fm` command, enter:
.. code-block::
~(keystone_admin)]$ fm help <command>

13
doc/source/shared/_includes/cli-ref-intro-sw.rest Normal file
View File

@ -0,0 +1,13 @@
.. include:: /shared/_includes/uline.rest
:command:`sw-manager` is the command-line interface for the |VIM| Orchestration
APIs.
This page documents the :command:`sw-manager` command.
For a full description of usage and optional arguments for a specific
:command:`sw-manager` command, enter:
.. code-block::
~(keystone_admin)]$ sw-manager <command> -h

13
doc/source/shared/_includes/cli-ref-intro-system.rest Normal file
View File

@ -0,0 +1,13 @@
.. include:: /shared/_includes/uline.rest
:command:`system` is the command-line interface for System Inventory and
Maintenance.
This page documents the :command:`system` command in |prod|.
For a full description of usage and optional arguments for a specific
:command:`system` command, enter:
.. code-block::
~(keystone_admin)]$ system help <command>

1
doc/source/shared/abbrevs.txt
View File

@ -180,6 +180,7 @@
.. |VFs| replace:: :abbr:`VFs (Virtual Functions)`
.. |vGPU| replace:: :abbr:`vGPU (Virtual Graphics Processing Unit)`
.. |vGPUs| replace:: :abbr:`vGPUs (Virtual Graphics Processing Units)`
.. |VIM| replace:: :abbr:`VIM (Virtual Infrastructure Management)`
.. |VLAN| replace:: :abbr:`VLAN (Virtual Local Area Network)`
.. |VLANs| replace:: :abbr:`VLANs (Virtual Local Area Networks)`
.. |VM| replace:: :abbr:`VM (Virtual Machine)`