Skip to content

Commit

Permalink
OSDOCS-5243 Adding CLI Manager docs
Browse files Browse the repository at this point in the history
  • Loading branch information
cbippley committed Oct 3, 2024
1 parent 8ec63c3 commit b1cfd22
Show file tree
Hide file tree
Showing 16 changed files with 121 additions and 0 deletions.
1 change: 1 addition & 0 deletions _attributes/common-attributes.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
13 changes: 13 additions & 0 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -920,6 +920,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
Expand Down
1 change: 1 addition & 0 deletions cli_reference/cli_manager/_attributes
19 changes: 19 additions & 0 deletions cli_reference/cli_manager/cli-manager-install.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
:_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.
In disconnected environments it is difficult to install and manage CLI plugins. The CLI Manager was created to make installing and managing CLI plugins in disconnected environments easier for users.

// About the CLI Manager
include::modules/cli-manager-about.adoc[leveloffset=+1]

// Installing the {cli-manager}
include::modules/cli-manager-installing.adoc[leveloffset=+1]

// Adding CLI plugins
include::modules/cli-manager-adding-plugins.adoc[leveloffset=+1]
33 changes: 33 additions & 0 deletions cli_reference/cli_manager/cli-manager-release-notes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
:_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

//To update to the latest version of plugin;

//$ oc krew update
12 changes: 12 additions & 0 deletions cli_reference/cli_manager/cli-manager-uninstall.adoc
Original file line number Diff line number Diff line change
@@ -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]
12 changes: 12 additions & 0 deletions cli_reference/cli_manager/cli-manager-using.adoc
Original file line number Diff line number Diff line change
@@ -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]
1 change: 1 addition & 0 deletions cli_reference/cli_manager/images
Empty file.
1 change: 1 addition & 0 deletions cli_reference/cli_manager/modules
1 change: 1 addition & 0 deletions cli_reference/cli_manager/snippets
9 changes: 9 additions & 0 deletions modules/cli-manager-about.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// Module included in the following assemblies:
//
// * cli_reference/cli_manager/cli-manager-install.adoc

:_mod-docs-content-type: CONCEPT
[id="cli-manager-about_{context}"]
= About the CLI Manager

The CLI Manager
12 changes: 12 additions & 0 deletions modules/cli-manager-adding-plugins.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// Module included in the following assemblies:
//
// * cli_reference/cli_manager/cli-manager-install.adoc

:_mod-docs-content-type: PROCEDURE
[id="cli-manager-adding-plugins_{context}"]
= Adding CLI plugins with the CLI Manager

To search, install a plugin;

$ oc krew search test
$ oc krew install $CUSTOM_INDEX_NAME/test
4 changes: 4 additions & 0 deletions modules/cli-manager-installing.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
To search, install a plugin;

$ oc krew search test
$ oc krew install $CUSTOM_INDEX_NAME/test
Empty file.
2 changes: 2 additions & 0 deletions modules/cli-manager-uninstalling.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
To remove a plugin
$ oc krew remove test

0 comments on commit b1cfd22

Please sign in to comment.