Merge pull request #44656 from abrennan89/CLIupdates

SRVCOM-1728: Update structure and abstracts for CLI / ref docs

Author: abrennan89

_topic_maps/_topic_map.yml

@@ -493,7 +493,7 @@ Dir: updating
 Distros: openshift-origin,openshift-enterprise
 Topics:
 - Name: Updating clusters overview
-  File: index  
+  File: index
 - Name: Understanding OpenShift updates
   File: understanding-openshift-updates
 - Name: Understanding upgrade channels
@@ -3411,9 +3411,22 @@ Topics:
     File: installing-knative-eventing
   - Name: Removing OpenShift Serverless
     File: removing-openshift-serverless
-#- Name: Get started
-#  File: serverless-getting-started
-# uncomment once new content is added for this
+# Knative kn CLI
+- Name: Knative CLI
+  Dir: cli_tools
+  Topics:
+  - Name: Installing the Knative CLI
+    File: installing-kn
+  - Name: Configuring the Knative CLI
+    File: advanced-kn-config
+  - Name: Knative CLI plug-ins
+    File: kn-plugins
+  - Name: Knative Serving CLI commands
+    File: kn-serving-ref
+  - Name: Knative Eventing CLI commands
+    File: kn-eventing-ref
+  - Name: Functions commands
+    File: kn-func-ref
 - Name: Develop
   Dir: develop
   Topics:
@@ -3543,24 +3556,3 @@ Topics:
   Topics:
   - Name: Using NVIDIA GPU resources with serverless applications
     File: gpu-resources
-# CLI tools
-- Name: CLI tools
-  Dir: cli_tools
-  Topics:
-  - Name: Installing the Knative CLI
-    File: installing-kn
-  - Name: Knative CLI advanced configuration
-    File: advanced-kn-config
-- Name: Reference
-  Dir: reference
-  Topics:
-  - Name: Knative CLI flags
-    File: kn-flags-reference
-  - Name: Knative Serving CLI commands
-    File: kn-serving-ref
-  - Name: Knative Eventing CLI commands
-    File: kn-eventing-ref
-  - Name: Functions commands
-    File: kn-func-ref
-  - Name: kn event
-    File: kn-event-ref

_topic_maps/_topic_map_osd.yml

@@ -242,6 +242,19 @@ Topics:
     File: installing-knative-eventing
   - Name: Removing OpenShift Serverless
     File: removing-openshift-serverless
+- Name: Knative CLI
+  Dir: cli_tools
+  Topics:
+  - Name: Installing the Knative CLI
+    File: installing-kn
+  - Name: Configuring the Knative CLI
+    File: advanced-kn-config
+  - Name: Knative Serving CLI commands
+    File: kn-serving-ref
+  - Name: Knative Eventing CLI commands
+    File: kn-eventing-ref
+  - Name: Functions commands
+    File: kn-func-ref
 - Name: Develop
   Dir: develop
   Topics:
@@ -349,26 +362,6 @@ Topics:
     File: serverless-functions-annotations
   - Name: Functions development reference guide
     File: serverless-functions-reference-guide
-- Name: CLI tools
-  Dir: cli_tools
-  Topics:
-  - Name: Installing the Knative CLI
-    File: installing-kn
-  - Name: Knative CLI advanced configuration
-    File: advanced-kn-config
-- Name: Reference
-  Dir: reference
-  Topics:
-  - Name: Knative CLI flags
-    File: kn-flags-reference
-  - Name: Knative Serving CLI commands
-    File: kn-serving-ref
-  - Name: Knative Eventing CLI commands
-    File: kn-eventing-ref
-  - Name: Functions commands
-    File: kn-func-ref
-  - Name: kn event
-    File: kn-event-ref
 ---
 Name: Support
 Dir: support

modules/serverless-build-events-kn.adoc

@@ -1,9 +1,13 @@
 :_content-type: PROCEDURE
 [id="serverless-build-events-kn_{context}"]
-= Building events
+= Building events by using the kn-event plug-in
 
 You can use the builder-like interface of the `kn event build` command to build an event. You can then send that event at a later time or use it in another context.
 
+.Prerequisites
+
+* You have installed the Knative (`kn`) CLI.
+
 .Procedure
 
 * Build an event:

modules/serverless-installing-cli-linux-rpm-package-manager.adoc

@@ -0,0 +1,53 @@
+// Module included in the following assemblies:
+//
+// * serverless/cli_tools/installing-kn.adoc
+
+:_content-type: PROCEDURE
+[id="serverless-installing-cli-linux-rpm-package-manager_{context}"]
+= Installing the Knative CLI for Linux by using an RPM package manager
+
+For {op-system-base-full}, you can install the Knative (`kn`) CLI as an RPM by using a package manager, such as `yum` or `dnf`. This allows the Knative CLI version to be automatically managed by the system. For example, using a command like `dnf upgrade` upgrades all packages, including `kn`, if a new version is available.
+
+.Prerequisites
+
+* You have an active {product-title} subscription on your Red Hat account.
+
+.Procedure
+
+. Register with Red Hat Subscription Manager:
++
+[source,terminal]
+----
+# subscription-manager register
+----
+
+. Pull the latest subscription data:
++
+[source,terminal]
+----
+# subscription-manager refresh
+----
+
+. Attach the subscription to the registered system:
++
+[source,terminal]
+----
+# subscription-manager attach --pool=<pool_id> <1>
+----
++
+<1> Pool ID for an active {product-title} subscription
+
+. Enable the repositories required by the Knative (`kn`) CLI:
++
+[source,terminal]
+----
+# subscription-manager repos --enable="openshift-serverless-1-for-rhel-8-x86_64-rpms"
+----
+
+. Install the Knative (`kn`) CLI as an RPM by using a package manager:
++
+.Example `yum` command
+[source,terminal]
+----
+# yum install openshift-serverless-clients
+----

modules/serverless-installing-cli-linux-rpm.adoc

@@ -6,19 +6,31 @@
 [id="installing-cli-linux_{context}"]
 = Installing the Knative CLI for Linux
 
-For Linux distributions, you can download the `kn` CLI directly as a `tar.gz` archive.
+If you are using a Linux distribution that does not have RPM or another package manager installed, you can install the Knative (`kn`) CLI as a binary file. To do this, you must download and unpack a `tar.gz` archive and add the binary to a directory on your `PATH`.
 
-// no prereqs?
+.Prerequisites
+
+* If you are not using RHEL or Fedora, ensure that *libc* is installed in a directory on your library path.
++
+[IMPORTANT]
+====
+If *libc* is not available, you might see the following error when you run CLI commands:
+
+[source,terminal]
+----
+$ kn: No such file or directory
+----
+====
 
 .Procedure
 
-. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/serverless/latest/kn-linux-amd64.tar.gz[`kn` CLI].
+. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/serverless/latest/kn-linux-amd64.tar.gz[Knative (`kn`) CLI `tar.gz` archive].
 
 . Unpack the archive:
 +
 [source,terminal]
 ----
-$ tar -xf <file>
+$ tar -xf <filename>
 ----
 
 . Move the `kn` binary to a directory on your `PATH`.
@@ -29,14 +41,3 @@ $ tar -xf <file>
 ----
 $ echo $PATH
 ----
-+
-[NOTE]
-====
-If you do not use RHEL or Fedora, ensure that *libc* is installed in a directory on your library path.
-If *libc* is not available, you might see the following error when you run CLI commands:
-
-[source,terminal]
-----
-$ kn: No such file or directory
-----
-====

modules/serverless-installing-cli-linux.adoc

@@ -3,18 +3,18 @@
 // * serverless/cli_tools/installing-kn.adoc
 
 :_content-type: PROCEDURE
-[id="installing-cli-macosx_{context}"]
+[id="serverless-installing-cli-macos_{context}"]
 = Installing the Knative CLI for macOS
 
-The `kn` CLI for macOS is provided as a `tar.gz` archive.
+If you are using macOS, you can install the Knative (`kn`) CLI as a binary file. To do this, you must download and unpack a `tar.gz` archive and add the binary to a directory on your `PATH`.
 
 // no prereqs?
 
 .Procedure
 
-. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/serverless/latest/kn-macos-amd64.tar.gz[`kn` CLI].
+. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/serverless/latest/kn-macos-amd64.tar.gz[Knative (`kn`) CLI `tar.gz` archive].
 
-. Unpack and unzip the archive.
+. Unpack and extract the archive.
 
 . Move the `kn` binary to a directory on your `PATH`.
 

modules/serverless-installing-cli-macos.adoc

@@ -6,12 +6,22 @@
 [id="installing-cli-web-console_{context}"]
 = Installing the Knative CLI using the {product-title} web console
 
-You can use the following procedure to install the `kn` CLI by using the web console.
+Using the {product-title} web console provides a streamlined and intuitive user interface to install the Knative (`kn`) CLI. After the {ServerlessOperatorName} is installed, you will see a link to download the Knative (`kn`) CLI for Linux (amd64, s390x, ppc64le), macOS, or Windows from the *Command Line Tools* page in the {product-title} web console.
 
 .Prerequisites
 
 * You have logged in to the {product-title} web console.
-* The {ServerlessOperatorName} is installed on your {product-title} cluster. After the {ServerlessOperatorName} is installed, you will see a link to download the Knative CLI (`kn`) for Linux (x86_64, amd64, s390x, ppc64le), macOS, or Windows from the *Command Line Tools* page in the {product-title} web console.
+* The {ServerlessOperatorName} is installed on your {product-title} cluster.
++
+[IMPORTANT]
+====
+If *libc* is not available, you might see the following error when you run CLI commands:
+
+[source,terminal]
+----
+$ kn: No such file or directory
+----
+====
 
 .Procedure
 
@@ -23,22 +33,12 @@ You can use the following procedure to install the `kn` CLI by using the web con
 ----
 $ tar -xf <file>
 ----
+
 . Move the `kn` binary to a directory on your `PATH`.
+
 . To check your `PATH`, run:
 +
 [source,terminal]
 ----
 $ echo $PATH
 ----
-+
-[NOTE]
-====
-If you do not use RHEL or Fedora, ensure that *libc* is installed in a directory on your library path.
-If *libc* is not available, you might see the following error when you run CLI commands:
-
-[source,terminal]
-----
-$ kn: No such file or directory
-----
-
-====

modules/serverless-installing-cli-web-console.adoc

@@ -6,13 +6,13 @@
 [id="installing-cli-windows_{context}"]
 = Installing the Knative CLI for Windows
 
-The `kn` CLI for Windows is provided as a zip archive.
+If you are using Windows, you can install the Knative (`kn`) CLI as a binary file. To do this, you must download and unpack a ZIP archive and add the binary to a directory on your `PATH`.
 
 // no prereqs?
 
 .Procedure
 
-. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/serverless/latest/kn-windows-amd64.zip[`kn` CLI].
+. Download the link:https://mirror.openshift.com/pub/openshift-v4/clients/serverless/latest/kn-windows-amd64.zip[Knative (`kn`) CLI ZIP archive].
 
 . Extract the archive with a ZIP program.