From ac1617a36e06bed6fc009b1cb96050072f17e5ef Mon Sep 17 00:00:00 2001 From: cbippley Date: Fri, 6 Sep 2024 14:05:47 -0400 Subject: [PATCH] OSDOCS-5243 Adding CLI Manager docs --- _attributes/common-attributes.adoc | 1 + _topic_maps/_topic_map.yml | 13 +++++++++ .../cli_manager/cli-manager-install.adoc | 12 ++++++++ .../cli-manager-release-notes.adoc | 29 +++++++++++++++++++ .../cli_manager/cli-manager-uninstall.adoc | 12 ++++++++ .../cli_manager/cli-manager-using.adoc | 12 ++++++++ getting_started/cli_manager/index.adoc | 0 modules/cli-manager-installing.adoc | 0 modules/cli-manager-overview.adoc | 0 modules/cli-manager-uninstalling.adoc | 0 10 files changed, 79 insertions(+) create mode 100644 getting_started/cli_manager/cli-manager-install.adoc create mode 100644 getting_started/cli_manager/cli-manager-release-notes.adoc create mode 100644 getting_started/cli_manager/cli-manager-uninstall.adoc create mode 100644 getting_started/cli_manager/cli-manager-using.adoc create mode 100644 getting_started/cli_manager/index.adoc create mode 100644 modules/cli-manager-installing.adoc create mode 100644 modules/cli-manager-overview.adoc create mode 100644 modules/cli-manager-uninstalling.adoc diff --git a/_attributes/common-attributes.adoc b/_attributes/common-attributes.adoc index 45c6a7e414a6..facd37cea078 100644 --- a/_attributes/common-attributes.adoc +++ b/_attributes/common-attributes.adoc @@ -52,6 +52,7 @@ endif::[] :secondary-scheduler-operator-full: Secondary Scheduler Operator for Red Hat OpenShift :secondary-scheduler-operator: Secondary Scheduler Operator :descheduler-operator: Kube Descheduler Operator +:cli-manager: Openshift CLI Manager // Backup and restore :velero-domain: velero.io :velero-version: 1.14 diff --git a/_topic_maps/_topic_map.yml b/_topic_maps/_topic_map.yml index 076e1b884e0b..76f255123cbd 100644 --- a/_topic_maps/_topic_map.yml +++ b/_topic_maps/_topic_map.yml @@ -65,6 +65,19 @@ Topics: File: openshift-overview - Name: Web console walkthrough File: openshift-web-console +-Name: OpenShift CLI Manager + Dir: cli_manager + Topics: + - Name: OpenShift CLI Manager overview + File: index + - Name: OpenShift CLI Manager release notes + File: cli-manager-release-notes + - Name: Installing the Openshift CLI Manager + File: cli-manager-install + - Name: Using the OpenShift CLI Manager + File: cli-manager-using + - Name: Uninstalling the OpenShift CLI Manager + File: cli-manager-uninstall - Name: Command-line walkthrough File: openshift-cli --- diff --git a/getting_started/cli_manager/cli-manager-install.adoc b/getting_started/cli_manager/cli-manager-install.adoc new file mode 100644 index 000000000000..a4d121166ffe --- /dev/null +++ b/getting_started/cli_manager/cli-manager-install.adoc @@ -0,0 +1,12 @@ +:_content-type: ASSEMBLY +[id="cli-manager-install_{context}"] += Installing the {cli-manager} +include::_attributes/common-attributes.adoc[] +:context: cli-manager-install + +toc::[] + +//Brief explanation of what the cli manager is. + +// Installing the {cli-manager} +include::modules/cli-manager-installing.adoc[leveloffset=+1] \ No newline at end of file diff --git a/getting_started/cli_manager/cli-manager-release-notes.adoc b/getting_started/cli_manager/cli-manager-release-notes.adoc new file mode 100644 index 000000000000..8e8fd3b6e29f --- /dev/null +++ b/getting_started/cli_manager/cli-manager-release-notes.adoc @@ -0,0 +1,29 @@ +:_content-type: ASSEMBLY +[id="cli-manager-release-notes_{context}"] += {cli-manager} release notes +include::_attributes/common-attributes.adoc[] +:context: cli-manager-release-notes + +toc::[] + +//Add release notes overview + +These release notes track the development of the {cli-manager} for {product-title}. + +For an overview of the {run-once-operator}, see xref:../../../nodes/pods/run_once_duration_override/index.adoc#run-once-about_run-once-duration-override-about[About the {run-once-operator}]. + +[id="cli-manager-release-notes-1-0-0_{context}"] +== {cli-manager} 1.0.0 + +Issued: 5 November 2024 + +The following advisory is available for the {cli-manager} 1.0.0: +//add correct link +* link:https://access.redhat.com/errata/RHEA-2023:2035[RHEA-2023:2035] + +[id="cli-manager-1-0-0-new-features-and-enhancements_{context}"] +=== New features and enhancements + +* This is the initial, generally available release of the {cli-manager}. For installation information, see xref:../../../getting_started/cli_manager/cli-manager-install.adoc#run-once-duration-override-install[Installing the {run-once-operator}]. + +// No bug fixes or known issues to list \ No newline at end of file diff --git a/getting_started/cli_manager/cli-manager-uninstall.adoc b/getting_started/cli_manager/cli-manager-uninstall.adoc new file mode 100644 index 000000000000..99ab1c4f552f --- /dev/null +++ b/getting_started/cli_manager/cli-manager-uninstall.adoc @@ -0,0 +1,12 @@ +:_content-type: ASSEMBLY +[id="cli-manager-uninstall_{context}"] += Uninstalling the {cli-manager} +include::_attributes/common-attributes.adoc[] +:context: cli-manager-uninstall + +toc::[] +// are there resources to remove? +You can remove the {cli-manager} from {product-title} by uninstalling the {cli-manager} and removing its related resources. + +// Uninstalling the {cli-manager} +include::modules/cli-manager-uninstalling.adoc[leveloffset=+1] \ No newline at end of file diff --git a/getting_started/cli_manager/cli-manager-using.adoc b/getting_started/cli_manager/cli-manager-using.adoc new file mode 100644 index 000000000000..4fe8836f955e --- /dev/null +++ b/getting_started/cli_manager/cli-manager-using.adoc @@ -0,0 +1,12 @@ +:_content-type: ASSEMBLY +[id="cli-manager-install_{context}"] += Using the {cli-manager} +include::_attributes/common-attributes.adoc[] +:context: cli-manager-using + +toc::[] + +//Brief explanation of what the cli manager is. + +// {cli-manager} overview +include::modules/cli-manager-overview.adoc[leveloffset=+1] \ No newline at end of file diff --git a/getting_started/cli_manager/index.adoc b/getting_started/cli_manager/index.adoc new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/modules/cli-manager-installing.adoc b/modules/cli-manager-installing.adoc new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/modules/cli-manager-overview.adoc b/modules/cli-manager-overview.adoc new file mode 100644 index 000000000000..e69de29bb2d1 diff --git a/modules/cli-manager-uninstalling.adoc b/modules/cli-manager-uninstalling.adoc new file mode 100644 index 000000000000..e69de29bb2d1