Skip to content

Commit 05b5977

Browse files
authored
Merge pull request #14172 from bergerhoffer/fixing-typo
Fixing typos and minor wording changes for CLI
2 parents f3905eb + 274a5be commit 05b5977

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

cli_reference/extending-cli-plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ include::modules/common-attributes.adoc[]
66
toc::[]
77

88
You can write and install plug-ins to build on the default `oc` commands,
9-
allowing you to peform new and more complex tasks with the {product-title} CLI.
9+
allowing you to perform new and more complex tasks with the {product-title} CLI.
1010

1111
// Writing CLI plug-ins
1212
include::modules/cli-extending-plugins-writing.adoc[leveloffset=+1]

modules/cli-extending-plugins-installing.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
[id='cli-installing-plugins-{context}']
66
= Installing and using CLI plug-ins
77

8-
After you write a custom plug-in for the {product-title} CLI, you can install it
9-
to use the additional functionality that it introduces.
8+
After you write a custom plug-in for the {product-title} CLI, you must install
9+
it to use the functionality that it provides.
1010

1111
[IMPORTANT]
1212
====
@@ -40,7 +40,7 @@ $ chmod +x <plugin_file>
4040
----
4141
$ sudo mv <plugin_file> /usr/local/bin/.
4242
----
43-
. Run `oc plugin list` to make sure that the plug-in file is listed.
43+
. Run `oc plugin list` to make sure that the plug-in is listed.
4444
+
4545
----
4646
$ oc plugin list
@@ -49,7 +49,7 @@ The following compatible plugins are available:
4949
/usr/local/bin/<plugin_file>
5050
----
5151
+
52-
If your plug-in is not listed here, verify that the file name begins with `oc-`
52+
If your plug-in is not listed here, verify that the file begins with `oc-`
5353
or `kubectl-`, is executable, and is on your `PATH`.
5454
. Invoke the new command or option introduced by the plug-in.
5555
+

modules/cli-extending-plugins-writing.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,8 @@ terminal when the `oc foo` command is issued.
3333
+
3434
When naming your plug-in file, keep the following in mind:
3535

36-
* The file must begin with `oc-` or `kubectl-`.
36+
* The file must begin with `oc-` or `kubectl-` in order to be recognized as a
37+
plug-in.
3738
* The file name determines the command that invokes the plug-in. For example, a
3839
plug-in with the file name `oc-foo-bar` can be invoked by a command of
3940
`oc foo bar`. You can also use underscores if you want the command to contain

0 commit comments

Comments
 (0)