Merge pull request #29139 from adellape/openshift_cli_naming

Use 'OpenShift CLI' name unambiguously

Author: adellape

_topic_map.yml

@@ -449,6 +449,104 @@ Topics:
   File: disabling-web-console
   Distros: openshift-enterprise,openshift-webscale,openshift-origin
 ---
+Name: CLI tools
+Dir: cli_reference
+Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
+Topics:
+- Name: OpenShift CLI (oc)
+  Dir: openshift_cli
+  Topics:
+  - Name: Getting started with the OpenShift CLI
+    File: getting-started-cli
+  - Name: Configuring the OpenShift CLI
+    File: configuring-cli
+  - Name: Extending the OpenShift CLI with plug-ins
+    File: extending-cli-plugins
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin
+  - Name: OpenShift CLI developer commands
+    File: developer-cli-commands
+  - Name: OpenShift CLI administrator commands
+    File: administrator-cli-commands
+    Distros: openshift-enterprise,openshift-webscale,openshift-origin
+  - Name: Usage of oc and kubectl commands
+    File: usage-oc-kubectl
+- Name: Developer CLI (odo)
+  Dir: developer_cli_odo
+  Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
+  Topics:
+  - Name: Understanding odo
+    File: understanding-odo
+  - Name: Installing odo
+    File: installing-odo
+  - Name: Creating and deploying applications with odo
+    Dir: creating_and_deploying_applications_with_odo
+    Topics:
+      - Name: Working with projects
+        File: working-with-projects
+      - Name: Creating a single-component application with odo
+        File: creating-a-single-component-application-with-odo
+      - Name: Creating a multicomponent application with odo
+        File: creating-a-multicomponent-application-with-odo
+      - Name: Creating an application with a database
+        File: creating-an-application-with-a-database
+      - Name: Using devfiles in odo
+        File: using-devfiles-in-odo
+      - Name: Working with storage
+        File: working-with-storage
+      - Name: Deleting applications
+        File: deleting-applications
+      - Name: Debugging applications in odo
+        File: debugging-applications-in-odo
+      - Name: Sample applications
+        File: sample-applications
+  - Name: Using odo in a restricted environment
+    Dir: using_odo_in_a_restricted_environment
+    Topics:
+    - Name: About odo in a restricted environment
+      File: about-odo-in-a-restricted-environment
+    - Name: Pushing the odo init image to the restricted cluster registry
+      File: pushing-the-odo-init-image-to-the-restricted-cluster-registry
+    - Name: Creating and deploying a component to the disconnected cluster
+      File: creating-and-deploying-a-component-to-the-disconnected-cluster
+  - Name: Creating instances of services managed by Operators
+    File: creating-instances-of-services-managed-by-operators
+  - Name: Managing environment variables in odo
+    File: managing-environment-variables-in-odo
+  - Name: Configuring the odo CLI
+    File: configuring-the-odo-cli
+  - Name: odo CLI reference
+    File: odo-cli-reference
+  - Name: odo architecture
+    File: odo-architecture
+  - Name: odo release notes
+    File: odo-release-notes
+- Name: Helm CLI
+  Dir: helm_cli
+  Distros: openshift-enterprise,openshift-webscale,openshift-origin
+  Topics:
+  - Name: Getting started with Helm on OpenShift Container Platform
+    File: getting-started-with-helm-on-openshift-container-platform
+  - Name: Configuring custom Helm chart repositories
+    File: configuring-custom-helm-chart-repositories
+  - Name: Disabling Helm chart repositories
+    File: disabling-helm-chart-repositories
+- Name: Knative CLI (kn) for use with OpenShift Serverless
+  File: kn-cli-tools
+  Distros: openshift-enterprise,openshift-webscale,openshift-origin
+- Name: Pipelines CLI (tkn)
+  Dir: tkn_cli
+  Distros: openshift-enterprise,openshift-webscale,openshift-origin
+  Topics:
+  - Name: Installing tkn
+    File: installing-tkn
+  - Name: Configuring tkn
+    File: op-configuring-tkn
+  - Name: Basic tkn commands
+    File: op-tkn-reference
+- Name: opm CLI
+  File: opm-cli
+  Distros: openshift-enterprise,openshift-webscale,openshift-origin
+---
 Name: Security and compliance
 Dir: security
 Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-aro
@@ -1707,104 +1805,6 @@ Topics:
   - Name: Troubleshooting
     File: troubleshooting-4-2-4
 ---
-Name: CLI tools
-Dir: cli_reference
-Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
-Topics:
-- Name: OpenShift CLI (oc)
-  Dir: openshift_cli
-  Topics:
-  - Name: Getting started with the CLI
-    File: getting-started-cli
-  - Name: Configuring the CLI
-    File: configuring-cli
-  - Name: Extending the CLI with plug-ins
-    File: extending-cli-plugins
-    Distros: openshift-enterprise,openshift-webscale,openshift-origin
-  - Name: Developer CLI commands
-    File: developer-cli-commands
-  - Name: Administrator CLI commands
-    File: administrator-cli-commands
-    Distros: openshift-enterprise,openshift-webscale,openshift-origin
-  - Name: Usage of oc and kubectl commands
-    File: usage-oc-kubectl
-- Name: Developer CLI (odo)
-  Dir: developer_cli_odo
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-online
-  Topics:
-  - Name: Understanding odo
-    File: understanding-odo
-  - Name: Installing odo
-    File: installing-odo
-  - Name: Creating and deploying applications with odo
-    Dir: creating_and_deploying_applications_with_odo
-    Topics:
-      - Name: Working with projects
-        File: working-with-projects
-      - Name: Creating a single-component application with odo
-        File: creating-a-single-component-application-with-odo
-      - Name: Creating a multicomponent application with odo
-        File: creating-a-multicomponent-application-with-odo
-      - Name: Creating an application with a database
-        File: creating-an-application-with-a-database
-      - Name: Using devfiles in odo
-        File: using-devfiles-in-odo
-      - Name: Working with storage
-        File: working-with-storage
-      - Name: Deleting applications
-        File: deleting-applications
-      - Name: Debugging applications in odo
-        File: debugging-applications-in-odo
-      - Name: Sample applications
-        File: sample-applications
-  - Name: Using odo in a restricted environment
-    Dir: using_odo_in_a_restricted_environment
-    Topics:
-    - Name: About odo in a restricted environment
-      File: about-odo-in-a-restricted-environment
-    - Name: Pushing the odo init image to the restricted cluster registry
-      File: pushing-the-odo-init-image-to-the-restricted-cluster-registry
-    - Name: Creating and deploying a component to the disconnected cluster
-      File: creating-and-deploying-a-component-to-the-disconnected-cluster
-  - Name: Creating instances of services managed by Operators
-    File: creating-instances-of-services-managed-by-operators
-  - Name: Managing environment variables in odo
-    File: managing-environment-variables-in-odo
-  - Name: Configuring the odo CLI
-    File: configuring-the-odo-cli
-  - Name: odo CLI reference
-    File: odo-cli-reference
-  - Name: odo architecture
-    File: odo-architecture
-  - Name: odo release notes
-    File: odo-release-notes
-- Name: Helm CLI
-  Dir: helm_cli
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin
-  Topics:
-  - Name: Getting started with Helm on OpenShift Container Platform
-    File: getting-started-with-helm-on-openshift-container-platform
-  - Name: Configuring custom Helm chart repositories
-    File: configuring-custom-helm-chart-repositories
-  - Name: Disabling Helm chart repositories
-    File: disabling-helm-chart-repositories
-- Name: Knative CLI (kn) for use with OpenShift Serverless
-  File: kn-cli-tools
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin
-- Name: Pipelines CLI (tkn)
-  Dir: tkn_cli
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin
-  Topics:
-  - Name: Installing tkn
-    File: installing-tkn
-  - Name: Configuring tkn
-    File: op-configuring-tkn
-  - Name: Basic tkn commands
-    File: op-tkn-reference
-- Name: opm CLI
-  File: opm-cli
-  Distros: openshift-enterprise,openshift-webscale,openshift-origin
----
 Name: API reference
 Dir: rest_api
 Topics:

cli_reference/openshift_cli/administrator-cli-commands.adoc

@@ -1,5 +1,5 @@
 [id="cli-administrator-commands"]
-= Administrator CLI commands
+= OpenShift CLI administrator commands
 include::modules/common-attributes.adoc[]
 :context: cli-administrator-commands
 

cli_reference/openshift_cli/configuring-cli.adoc

@@ -1,5 +1,5 @@
 [id="cli-configuring-cli"]
-= Configuring the CLI
+= Configuring the OpenShift CLI
 include::modules/common-attributes.adoc[]
 :context: cli-configuring-cli
 

cli_reference/openshift_cli/developer-cli-commands.adoc

@@ -1,5 +1,5 @@
 [id="cli-developer-commands"]
-= Developer CLI commands
+= OpenShift CLI developer commands
 include::modules/common-attributes.adoc[]
 :context: cli-developer-commands
 

cli_reference/openshift_cli/extending-cli-plugins.adoc

@@ -1,5 +1,5 @@
 [id="cli-extend-plugins"]
-= Extending the CLI with plug-ins
+= Extending the OpenShift CLI with plug-ins
 include::modules/common-attributes.adoc[]
 :context: cli-extend-plugins
 

cli_reference/openshift_cli/getting-started-cli.adoc

@@ -1,5 +1,5 @@
 [id="cli-getting-started"]
-= Getting started with the CLI
+= Getting started with the OpenShift CLI
 include::modules/common-attributes.adoc[]
 :context: cli-developer-commands
 
@@ -8,7 +8,8 @@ toc::[]
 // About the CLI
 include::modules/cli-about-cli.adoc[leveloffset=+1]
 
-== Installing the CLI
+[id="installing-openshift-cli"]
+== Installing the OpenShift CLI
 
 You can install the OpenShift CLI (`oc`) either by downloading the binary or by using an RPM.
 

cli_reference/openshift_cli/usage-oc-kubectl.adoc

@@ -3,7 +3,7 @@
 include::modules/common-attributes.adoc[]
 :context: usage-oc-kubectl
 
-Kubernetes' command line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because OpenShift Container Platform is a certified Kubernetes distribution, you can use the supported `kubectl` binaries that ship with {product-title}, or you can gain extended functionality by using the `oc` binary.
+The Kubernetes command line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because OpenShift Container Platform is a certified Kubernetes distribution, you can use the supported `kubectl` binaries that ship with {product-title}, or you can gain extended functionality by using the `oc` binary.
 
 == The oc binary
 
@@ -25,6 +25,6 @@ The additional command `oc new-app`, for example, makes it easier to get new app
 
 The `kubectl` binary is provided as a means to support existing workflows and scripts for new {product-title} users coming from a standard Kubernetes environment, or for those who prefer to use the `kubectl` CLI. Existing users of `kubectl` can continue to use the binary to interact with Kubernetes primitives, with no changes required to the {product-title} cluster.
 
-You can install the supported `kubectl` binary by following the steps to xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-installing-cli_cli-developer-commands[Install the CLI]. The `kubectl` binary is included in the archive if you download the binary, or is installed when you install the CLI by using an RPM.
+You can install the supported `kubectl` binary by following the steps to xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-installing-cli_cli-developer-commands[Install the OpenShift CLI]. The `kubectl` binary is included in the archive if you download the binary, or is installed when you install the CLI by using an RPM.
 
 For more information, see the link:https://kubernetes.io/docs/reference/kubectl/overview/[kubectl documentation].

contributing_to_docs/doc_guidelines.adoc

@@ -339,13 +339,13 @@ xref:../../architecture/networking/routes.adoc#architecture-core-concepts-routes
 .Markup example of cross-referencing
 ----
 Rollbacks revert part of an application back to a previous deployment. Rollbacks can be performed using the REST API or
-the xref:../cli_reference/openshift_cli/get_started_cli.adoc#installing-the-cli[OpenShift CLI].
+the xref:../cli_reference/openshift_cli/get_started_cli.adoc#installing-openshift-cli[OpenShift CLI].
 
 Before you can create a domain, you must first xref:../dev_guide/application_lifecycle/new_app.adoc#dev-guide-new-app[create an application].
 ----
 
 .Rendered output of cross-referencing
-> Rollbacks revert part of an application back to a previous deployment. Rollbacks can be performed using the REST API or the xref:../cli_reference/openshift_cli/get_started_cli.adoc#installing-the-cli[OpenShift CLI].
+> Rollbacks revert part of an application back to a previous deployment. Rollbacks can be performed using the REST API or the xref:../cli_reference/openshift_cli/get_started_cli.adoc#installing-openshift-cli[OpenShift CLI].
 >
 > Before you can create a domain, you must first xref:../dev_guide/application_lifecycle/new_app.adoc#dev-guide-new-app[create an application].
 

installing/installing_rhv/installing-rhv-customizations.adoc

@@ -68,7 +68,7 @@ include::modules/cli-installing-cli.adoc[leveloffset=+1]
 
 include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=+1]
 
-To learn more, see xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the CLI].
+To learn more, see xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI].
 
 include::modules/installation-osp-verifying-cluster-status.adoc[leveloffset=+1]
 

installing/installing_rhv/installing-rhv-default.adoc

@@ -53,7 +53,7 @@ You have completed the steps required to install the cluster. The remaining step
 
 include::modules/cli-installing-cli.adoc[leveloffset=1]
 
-To learn more, see xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the CLI].
+To learn more, see xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI].
 
 include::modules/cli-logging-in-kubeadmin.adoc[leveloffset=1]