From 8d1003e6dc80cbccb6dd080cbe0982bd254e5d1e Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Mon, 25 Sep 2023 18:12:39 +0000 Subject: [PATCH] Share CLI ref intros (r8, r7, r6, dsR8, dsR7, dsR6) Break out intro content for each CLI Ref for reusability. Convert VIM to an abbrev. Signed-off-by: Ron Stone Change-Id: I7f4ee6f9bd6120ad84b77dfcfeb900bfba362835 --- doc/source/cli_ref/dcmanager.rst | 8 ++------ doc/source/cli_ref/fm.rst | 4 +--- doc/source/cli_ref/sw-manager.rst | 5 +---- doc/source/cli_ref/system.rst | 5 +---- .../shared/_includes/cli-ref-intro-dcmanager.rest | 14 ++++++++++++++ doc/source/shared/_includes/cli-ref-intro-fm.rest | 12 ++++++++++++ doc/source/shared/_includes/cli-ref-intro-sw.rest | 13 +++++++++++++ .../shared/_includes/cli-ref-intro-system.rest | 13 +++++++++++++ doc/source/shared/abbrevs.txt | 1 + 9 files changed, 58 insertions(+), 17 deletions(-) create mode 100644 doc/source/shared/_includes/cli-ref-intro-dcmanager.rest create mode 100644 doc/source/shared/_includes/cli-ref-intro-fm.rest create mode 100644 doc/source/shared/_includes/cli-ref-intro-sw.rest create mode 100644 doc/source/shared/_includes/cli-ref-intro-system.rest diff --git a/doc/source/cli_ref/dcmanager.rst b/doc/source/cli_ref/dcmanager.rst index 9b616c75e..93fe3a48e 100644 --- a/doc/source/cli_ref/dcmanager.rst +++ b/doc/source/cli_ref/dcmanager.rst @@ -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 diff --git a/doc/source/cli_ref/fm.rst b/doc/source/cli_ref/fm.rst index 122d1d335..bbae15b6f 100644 --- a/doc/source/cli_ref/fm.rst +++ b/doc/source/cli_ref/fm.rst @@ -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: diff --git a/doc/source/cli_ref/sw-manager.rst b/doc/source/cli_ref/sw-manager.rst index 7bcccfa07..56757cedd 100644 --- a/doc/source/cli_ref/sw-manager.rst +++ b/doc/source/cli_ref/sw-manager.rst @@ -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: diff --git a/doc/source/cli_ref/system.rst b/doc/source/cli_ref/system.rst index af884c221..589a2dfc2 100644 --- a/doc/source/cli_ref/system.rst +++ b/doc/source/cli_ref/system.rst @@ -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: diff --git a/doc/source/shared/_includes/cli-ref-intro-dcmanager.rest b/doc/source/shared/_includes/cli-ref-intro-dcmanager.rest new file mode 100644 index 000000000..fc1d8393d --- /dev/null +++ b/doc/source/shared/_includes/cli-ref-intro-dcmanager.rest @@ -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 diff --git a/doc/source/shared/_includes/cli-ref-intro-fm.rest b/doc/source/shared/_includes/cli-ref-intro-fm.rest new file mode 100644 index 000000000..5a1f9e14f --- /dev/null +++ b/doc/source/shared/_includes/cli-ref-intro-fm.rest @@ -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 diff --git a/doc/source/shared/_includes/cli-ref-intro-sw.rest b/doc/source/shared/_includes/cli-ref-intro-sw.rest new file mode 100644 index 000000000..284862847 --- /dev/null +++ b/doc/source/shared/_includes/cli-ref-intro-sw.rest @@ -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 -h diff --git a/doc/source/shared/_includes/cli-ref-intro-system.rest b/doc/source/shared/_includes/cli-ref-intro-system.rest new file mode 100644 index 000000000..ef6b2ab55 --- /dev/null +++ b/doc/source/shared/_includes/cli-ref-intro-system.rest @@ -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 diff --git a/doc/source/shared/abbrevs.txt b/doc/source/shared/abbrevs.txt index 2e77edf05..055eb53af 100755 --- a/doc/source/shared/abbrevs.txt +++ b/doc/source/shared/abbrevs.txt @@ -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)`