OSDOCS-5243 Adding CLI Manager docs

openshift · Sep 20, 2024 · b371519 · b371519
1 parent 11a6893
commit b371519
Show file tree

Hide file tree

Showing 14 changed files with 83 additions and 0 deletions.
diff --git 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
@@ -917,6 +917,19 @@ Topics:
   - Name: OpenShift CLI administrator command reference
     File: administrator-cli-commands
     Distros: openshift-enterprise,openshift-origin
+- 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: Developer CLI (odo)
   File: odo-important-update
   # Dir: developer_cli_odo

diff --git a/cli_reference/cli_manager/_attributes b/cli_reference/cli_manager/_attributes
@@ -0,0 +1 @@
+../../_attributes
diff --git a/cli_reference/cli_manager/cli-manager-install.adoc b/cli_reference/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]
diff --git a/cli_reference/cli_manager/cli-manager-release-notes.adoc b/cli_reference/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
diff --git a/cli_reference/cli_manager/cli-manager-uninstall.adoc b/cli_reference/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]
diff --git a/cli_reference/cli_manager/cli-manager-using.adoc b/cli_reference/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]
diff --git a/cli_reference/cli_manager/images b/cli_reference/cli_manager/images
@@ -0,0 +1 @@
+../../images
diff --git a/cli_reference/cli_manager/index.adoc b/cli_reference/cli_manager/index.adoc
diff --git a/cli_reference/cli_manager/modules b/cli_reference/cli_manager/modules
@@ -0,0 +1 @@
+../../modules
diff --git a/cli_reference/cli_manager/snippets b/cli_reference/cli_manager/snippets
@@ -0,0 +1 @@
+../../snippets
diff --git a/modules/cli-manager-installing.adoc b/modules/cli-manager-installing.adoc
diff --git a/modules/cli-manager-overview.adoc b/modules/cli-manager-overview.adoc
diff --git a/modules/cli-manager-uninstalling.adoc b/modules/cli-manager-uninstalling.adoc