From 4278a92c9ba4684af4030c9c8a775ede1ca7837d Mon Sep 17 00:00:00 2001 From: Andrea Hoffer Date: Wed, 2 Oct 2019 11:30:49 -0400 Subject: [PATCH] Renaming CLI reference bucket to CLI tools --- _topic_map.yml | 29 ++++++++++--------- .../administrator-cli-commands.adoc | 0 .../{ => openshift_cli}/configuring-cli.adoc | 0 .../developer-cli-commands.adoc | 0 .../extending-cli-plugins.adoc | 0 .../getting-started-cli.adoc | 0 .../cnv-openshift-cluster-monitoring.adoc | 3 +- .../cnv-using-the-cli-tools.adoc | 5 ++-- contributing_to_docs/doc_guidelines.adoc | 6 ++-- modules/cli-about-cli.adoc | 2 +- .../cli-administrator-cluster-management.adoc | 2 +- modules/cli-administrator-configuration.adoc | 2 +- modules/cli-administrator-maintenance.adoc | 2 +- .../cli-administrator-node-management.adoc | 2 +- modules/cli-administrator-other.adoc | 2 +- .../cli-administrator-security-policy.adoc | 2 +- modules/cli-configuring-completion.adoc | 2 +- modules/cli-developer-advanced.adoc | 2 +- .../cli-developer-application-management.adoc | 2 +- modules/cli-developer-basic.adoc | 4 +-- modules/cli-developer-build-deploy.adoc | 2 +- modules/cli-developer-other.adoc | 2 +- modules/cli-developer-settings.adoc | 2 +- modules/cli-developer-troubleshooting.adoc | 2 +- modules/cli-extending-plugins-installing.adoc | 2 +- modules/cli-extending-plugins-writing.adoc | 2 +- modules/cli-getting-help.adoc | 2 +- modules/cli-installing-cli.adoc | 2 +- modules/cli-logging-in.adoc | 2 +- modules/cli-logging-out.adoc | 2 +- modules/cli-using-cli.adoc | 2 +- modules/pruning-images.adoc | 2 +- .../preparing-ossm-installation.adoc | 2 +- 33 files changed, 47 insertions(+), 46 deletions(-) rename cli_reference/{ => openshift_cli}/administrator-cli-commands.adoc (100%) rename cli_reference/{ => openshift_cli}/configuring-cli.adoc (100%) rename cli_reference/{ => openshift_cli}/developer-cli-commands.adoc (100%) rename cli_reference/{ => openshift_cli}/extending-cli-plugins.adoc (100%) rename cli_reference/{ => openshift_cli}/getting-started-cli.adoc (100%) diff --git a/_topic_map.yml b/_topic_map.yml index 4e35594c52..4794930a00 100644 --- a/_topic_map.yml +++ b/_topic_map.yml @@ -973,22 +973,25 @@ Topics: - Name: Recovering from expired control plane certificates File: scenario-3-expired-certs --- -Name: CLI reference +Name: CLI tools Dir: cli_reference Distros: openshift-enterprise,openshift-origin,openshift-dedicated 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-origin -- Name: Developer CLI commands - File: developer-cli-commands -- Name: Administrator CLI commands - File: administrator-cli-commands - Distros: openshift-enterprise,openshift-origin +- 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-origin + - Name: Developer CLI commands + File: developer-cli-commands + - Name: Administrator CLI commands + File: administrator-cli-commands + Distros: openshift-enterprise,openshift-origin --- Name: Service Mesh Dir: service_mesh diff --git a/cli_reference/administrator-cli-commands.adoc b/cli_reference/openshift_cli/administrator-cli-commands.adoc similarity index 100% rename from cli_reference/administrator-cli-commands.adoc rename to cli_reference/openshift_cli/administrator-cli-commands.adoc diff --git a/cli_reference/configuring-cli.adoc b/cli_reference/openshift_cli/configuring-cli.adoc similarity index 100% rename from cli_reference/configuring-cli.adoc rename to cli_reference/openshift_cli/configuring-cli.adoc diff --git a/cli_reference/developer-cli-commands.adoc b/cli_reference/openshift_cli/developer-cli-commands.adoc similarity index 100% rename from cli_reference/developer-cli-commands.adoc rename to cli_reference/openshift_cli/developer-cli-commands.adoc diff --git a/cli_reference/extending-cli-plugins.adoc b/cli_reference/openshift_cli/extending-cli-plugins.adoc similarity index 100% rename from cli_reference/extending-cli-plugins.adoc rename to cli_reference/openshift_cli/extending-cli-plugins.adoc diff --git a/cli_reference/getting-started-cli.adoc b/cli_reference/openshift_cli/getting-started-cli.adoc similarity index 100% rename from cli_reference/getting-started-cli.adoc rename to cli_reference/openshift_cli/getting-started-cli.adoc diff --git a/cnv/cnv_users_guide/cnv-openshift-cluster-monitoring.adoc b/cnv/cnv_users_guide/cnv-openshift-cluster-monitoring.adoc index 12fdfaa678..a563a9f55a 100644 --- a/cnv/cnv_users_guide/cnv-openshift-cluster-monitoring.adoc +++ b/cnv/cnv_users_guide/cnv-openshift-cluster-monitoring.adoc @@ -25,5 +25,4 @@ include::modules/telemetry-what-information-is-collected.adoc[leveloffset=+1] == CLI troubleshooting and debugging commands -For a list of the `oc` client troubleshooting and debugging commands, see the xref:../../cli_reference/developer-cli-commands.adoc#cli-troubleshooting-commands_developer-cli-commands[{product-title} CLI reference] documentation. - +For a list of the `oc` client troubleshooting and debugging commands, see the xref:../../cli_reference/openshift_cli/developer-cli-commands.adoc#cli-troubleshooting-commands_cli-developer-commands[{product-title} CLI tools] documentation. diff --git a/cnv/cnv_users_guide/cnv-using-the-cli-tools.adoc b/cnv/cnv_users_guide/cnv-using-the-cli-tools.adoc index bd15759fd5..c9845c8973 100644 --- a/cnv/cnv_users_guide/cnv-using-the-cli-tools.adoc +++ b/cnv/cnv_users_guide/cnv-using-the-cli-tools.adoc @@ -16,6 +16,5 @@ The two primary CLI tools used for managing resources in the cluster are: include::modules/cnv-virtctl-commands.adoc[leveloffset=+1] include::modules/cnv-openshift-client-commands.adoc[leveloffset=+1] -For more comprehensive information on `oc` client commands, see the -xref:../../cli_reference/developer-cli-commands.adoc#cli_reference[{product-title} CLI reference]. - +For more comprehensive information on `oc` client commands, see the +xref:../../cli_reference/openshift_cli/developer-cli-commands.adoc#cli_reference[{product-title} CLI tools] documentation. diff --git a/contributing_to_docs/doc_guidelines.adoc b/contributing_to_docs/doc_guidelines.adoc index 2cc7a18138..c396043f14 100644 --- a/contributing_to_docs/doc_guidelines.adoc +++ b/contributing_to_docs/doc_guidelines.adoc @@ -58,7 +58,7 @@ Example: ---- // Module included in the following assemblies: // -// * cli_reference/developer-cli-commands.adoc +// * cli_reference/openshift_cli/developer-cli-commands.adoc [id="cli-basic-commands_{context}"] = Basic CLI commands @@ -289,14 +289,14 @@ 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/get_started_cli.adoc#installing-the-cli[OpenShift CLI]. +the xref:../cli_reference/openshift_cli/get_started_cli.adoc#installing-the-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/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-the-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]. ==== diff --git a/modules/cli-about-cli.adoc b/modules/cli-about-cli.adoc index 5af1e8c0a9..f25f59635c 100644 --- a/modules/cli-about-cli.adoc +++ b/modules/cli-about-cli.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/getting-started.adoc +// * cli_reference/openshift_cli/getting-started.adoc [id="cli-about-cli_{context}"] = About the CLI diff --git a/modules/cli-administrator-cluster-management.adoc b/modules/cli-administrator-cluster-management.adoc index 2f2766bf73..b9a1272eed 100644 --- a/modules/cli-administrator-cluster-management.adoc +++ b/modules/cli-administrator-cluster-management.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/administrator-cli-commands.adoc +// * cli_reference/openshift_cli/administrator-cli-commands.adoc [id="cli-cluster-management-commands_{context}"] = Cluster management CLI commands diff --git a/modules/cli-administrator-configuration.adoc b/modules/cli-administrator-configuration.adoc index f31879f287..8d87d779f1 100644 --- a/modules/cli-administrator-configuration.adoc +++ b/modules/cli-administrator-configuration.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/administrator-cli-commands.adoc +// * cli_reference/openshift_cli/administrator-cli-commands.adoc [id="cli-configuration-commands_{context}"] = Configuration CLI commands diff --git a/modules/cli-administrator-maintenance.adoc b/modules/cli-administrator-maintenance.adoc index 818c2b68b4..3e5dc94e0c 100644 --- a/modules/cli-administrator-maintenance.adoc +++ b/modules/cli-administrator-maintenance.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/administrator-cli-commands.adoc +// * cli_reference/openshift_cli/administrator-cli-commands.adoc [id="cli-maintenance-commands_{context}"] = Maintenance CLI commands diff --git a/modules/cli-administrator-node-management.adoc b/modules/cli-administrator-node-management.adoc index 764d3f4572..76e087177a 100644 --- a/modules/cli-administrator-node-management.adoc +++ b/modules/cli-administrator-node-management.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/administrator-cli-commands.adoc +// * cli_reference/openshift_cli/administrator-cli-commands.adoc [id="cli-node-management-commands_{context}"] = Node management CLI commands diff --git a/modules/cli-administrator-other.adoc b/modules/cli-administrator-other.adoc index 49009bad36..affd531059 100644 --- a/modules/cli-administrator-other.adoc +++ b/modules/cli-administrator-other.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/administrator-cli-commands.adoc +// * cli_reference/openshift_cli/administrator-cli-commands.adoc [id="cli-other-administrator-commands_{context}"] = Other Administrator CLI commands diff --git a/modules/cli-administrator-security-policy.adoc b/modules/cli-administrator-security-policy.adoc index 2fddd43e8f..f60918afcf 100644 --- a/modules/cli-administrator-security-policy.adoc +++ b/modules/cli-administrator-security-policy.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/administrator-cli-commands.adoc +// * cli_reference/openshift_cli/administrator-cli-commands.adoc [id="cli-security-policy-commands_{context}"] = Security and policy CLI commands diff --git a/modules/cli-configuring-completion.adoc b/modules/cli-configuring-completion.adoc index baf7d017ad..9449341d64 100644 --- a/modules/cli-configuring-completion.adoc +++ b/modules/cli-configuring-completion.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/configuring-cli.adoc +// * cli_reference/openshift_cli/configuring-cli.adoc [id="cli-enabling-tab-completion_{context}"] = Enabling tab completion diff --git a/modules/cli-developer-advanced.adoc b/modules/cli-developer-advanced.adoc index d5d589bcb0..d427c557be 100644 --- a/modules/cli-developer-advanced.adoc +++ b/modules/cli-developer-advanced.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/developer-cli-commands.adoc +// * cli_reference/openshift_cli/developer-cli-commands.adoc [id="cli-advanced-developer-commands_{context}"] = Advanced developer CLI commands diff --git a/modules/cli-developer-application-management.adoc b/modules/cli-developer-application-management.adoc index 1576f13828..ce8357b801 100644 --- a/modules/cli-developer-application-management.adoc +++ b/modules/cli-developer-application-management.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/developer-cli-commands.adoc +// * cli_reference/openshift_cli/developer-cli-commands.adoc [id="cli-application-management-commands_{context}"] = Application management CLI commands diff --git a/modules/cli-developer-basic.adoc b/modules/cli-developer-basic.adoc index bc46a4d213..dca05ee5e0 100644 --- a/modules/cli-developer-basic.adoc +++ b/modules/cli-developer-basic.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/developer-cli-commands.adoc +// * cli_reference/openshift_cli/developer-cli-commands.adoc [id="cli-basic-commands_{context}"] = Basic CLI commands @@ -24,7 +24,7 @@ use. $ oc login ---- -.Example: Log in specifying a user name +.Example: Log in specifying a user name ---- $ oc login -u user1 ---- diff --git a/modules/cli-developer-build-deploy.adoc b/modules/cli-developer-build-deploy.adoc index 648de98f3a..cff466b0da 100644 --- a/modules/cli-developer-build-deploy.adoc +++ b/modules/cli-developer-build-deploy.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/developer-cli-commands.adoc +// * cli_reference/openshift_cli/developer-cli-commands.adoc [id="cli-build-deploy-commands_{context}"] = Build and Deploy CLI commands diff --git a/modules/cli-developer-other.adoc b/modules/cli-developer-other.adoc index c732a05cfc..1841fe26cf 100644 --- a/modules/cli-developer-other.adoc +++ b/modules/cli-developer-other.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/developer-cli-commands.adoc +// * cli_reference/openshift_cli/developer-cli-commands.adoc [id="cli-other-developer-commands_{context}"] = Other developer CLI commands diff --git a/modules/cli-developer-settings.adoc b/modules/cli-developer-settings.adoc index bb8e317fe1..b2c460b465 100644 --- a/modules/cli-developer-settings.adoc +++ b/modules/cli-developer-settings.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/developer-cli-commands.adoc +// * cli_reference/openshift_cli/developer-cli-commands.adoc [id="cli-settings-commands_{context}"] = Settings CLI commands diff --git a/modules/cli-developer-troubleshooting.adoc b/modules/cli-developer-troubleshooting.adoc index bb27d05f83..076ff79ecb 100644 --- a/modules/cli-developer-troubleshooting.adoc +++ b/modules/cli-developer-troubleshooting.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/developer-cli-commands.adoc +// * cli_reference/openshift_cli/developer-cli-commands.adoc [id="cli-troubleshooting-commands_{context}"] = Troubleshooting and debugging CLI commands diff --git a/modules/cli-extending-plugins-installing.adoc b/modules/cli-extending-plugins-installing.adoc index 2b873c7bc9..c382027c4c 100644 --- a/modules/cli-extending-plugins-installing.adoc +++ b/modules/cli-extending-plugins-installing.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/extending-cli-plugins.adoc +// * cli_reference/openshift_cli/extending-cli-plugins.adoc [id="cli-installing-plugins_{context}"] = Installing and using CLI plug-ins diff --git a/modules/cli-extending-plugins-writing.adoc b/modules/cli-extending-plugins-writing.adoc index 34ea63c45a..d3153e84c9 100644 --- a/modules/cli-extending-plugins-writing.adoc +++ b/modules/cli-extending-plugins-writing.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/extending-cli-plugins.adoc +// * cli_reference/openshift_cli/extending-cli-plugins.adoc [id="cli-writing-plugins_{context}"] = Writing CLI plug-ins diff --git a/modules/cli-getting-help.adoc b/modules/cli-getting-help.adoc index f2ecf896be..4b8933f748 100644 --- a/modules/cli-getting-help.adoc +++ b/modules/cli-getting-help.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/getting-started.adoc +// * cli_reference/openshift_cli/getting-started.adoc [id="cli-getting-help_{context}"] = Getting help diff --git a/modules/cli-installing-cli.adoc b/modules/cli-installing-cli.adoc index a3af9963eb..c03cfab42c 100644 --- a/modules/cli-installing-cli.adoc +++ b/modules/cli-installing-cli.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/getting-started.adoc +// * cli_reference/openshift_cli/getting-started.adoc // * installing/installing_aws_user_infra/installing-aws-user-infra.adoc // * installing/installing_aws/installing-aws-customizations.adoc // * installing/installing_aws/installing-aws-default.adoc diff --git a/modules/cli-logging-in.adoc b/modules/cli-logging-in.adoc index 7acf155ca0..73450d27f4 100644 --- a/modules/cli-logging-in.adoc +++ b/modules/cli-logging-in.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/getting-started.adoc +// * cli_reference/openshift_cli/getting-started.adoc [id="cli-logging-in_{context}"] = Logging in to the CLI diff --git a/modules/cli-logging-out.adoc b/modules/cli-logging-out.adoc index 6b5b132ac8..057c58a276 100644 --- a/modules/cli-logging-out.adoc +++ b/modules/cli-logging-out.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/getting-started.adoc +// * cli_reference/openshift_cli/getting-started.adoc [id="cli-logging-out_{context}"] = Logging out of the CLI diff --git a/modules/cli-using-cli.adoc b/modules/cli-using-cli.adoc index 6c06baa4dd..58ba64a8cc 100644 --- a/modules/cli-using-cli.adoc +++ b/modules/cli-using-cli.adoc @@ -1,6 +1,6 @@ // Module included in the following assemblies: // -// * cli_reference/getting-started.adoc +// * cli_reference/openshift_cli/getting-started.adoc [id="cli-using-cli_{context}"] = Using the CLI diff --git a/modules/pruning-images.adoc b/modules/pruning-images.adoc index b93885efdb..1c1203980f 100644 --- a/modules/pruning-images.adoc +++ b/modules/pruning-images.adoc @@ -334,7 +334,7 @@ is not recommended. //// Links needed for "Additional resources" list once converted: -xref:../cli_reference/get_started_cli.adoc#basic-setup-and-login[log in to the +xref:../cli_reference/openshift_cli/get_started_cli.adoc#basic-setup-and-login[log in to the CLI] as a user with an xref:../architecture/additional_concepts/authentication.adoc#oauth[access token]. The user must also have the cluster role diff --git a/service_mesh/service_mesh_install/preparing-ossm-installation.adoc b/service_mesh/service_mesh_install/preparing-ossm-installation.adoc index 35b9e3046d..a47506a3ca 100644 --- a/service_mesh/service_mesh_install/preparing-ossm-installation.adoc +++ b/service_mesh/service_mesh_install/preparing-ossm-installation.adoc @@ -16,7 +16,7 @@ Before you can install {ProductName}, review the installation activities, ensure ** xref:../../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install {product-title} 4.1 on bare metal] ** xref:../../installing/installing_vsphere/installing-vsphere.adoc#installing-vsphere[Install {product-title} 4.1 on vSphere] * Install the version of the {product-title} command line utility (the `oc` client tool) that matches your {product-title} version and add it to your path. -** If you are using {product-title} 4.1, see xref:../../cli_reference/getting-started-cli.adoc#cli-about-cli_cli-developer-commands[About the CLI]. +** If you are using {product-title} 4.1, see xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-about-cli_cli-developer-commands[About the CLI]. include::modules/ossm-supported-configurations.adoc[leveloffset=+1]