Skip to content

Commit a1402f8

Browse files
authored
Docs update - user guide (#687)
* Most of the changes for the user-guide section * Add follow up changes to user guide section
1 parent 06f7a00 commit a1402f8

File tree

10 files changed

+45
-46
lines changed

10 files changed

+45
-46
lines changed

site/content/docs/user-guide/configuration.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ weight: 900
99
## Customize installation directory {#custom-install-dir}
1010

1111
By default, Krew installs itself and plugins to `$HOME/.krew`. This means
12-
Krew itself and the installed plugins will be visible only to your user.
12+
Krew itself and the installed plugins will be visible only to the user who
13+
installed it.
1314

1415
To customize this installation path, set the `KREW_ROOT` environment variable
1516
while [installing Krew]({{< relref "setup/install.md" >}}). After Krew is
@@ -32,7 +33,7 @@ pointing to the [krew-index][ki] repository. You can force Krew to use a
3233
different repository by setting `KREW_DEFAULT_INDEX_URI` before running the
3334
[installation instructions]({{<ref "setup/install.md">}}) or after [removing the
3435
default index]({{<ref "using-custom-indexes.md#the-default-index">}}).
35-
`KREW_DEFAULT_INDEX_URI` should point to a git repository URI that uses a valid
36+
`KREW_DEFAULT_INDEX_URI` must point to a git repository URI that uses a valid
3637
git remote protocol.
3738

3839
To use a different default index, set the `KREW_DEFAULT_INDEX_URI` environment

site/content/docs/user-guide/install.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ slug: installing-plugins
44
weight: 400
55
---
66

7-
Plugins can be installed with `kubectl krew install` command:
7+
Plugins can be installed with the `kubectl krew install` command:
88

99
```text
1010
{{<prompt>}}kubectl krew install ca-cert

site/content/docs/user-guide/list.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,22 +4,22 @@ slug: list
44
weight: 500
55
---
66

7-
You can list all installed `kubectl` plugins (including those not installed via
8-
Krew) using:
7+
To list all plugins installed via Krew, run:
98

109
```sh
11-
{{<prompt>}}kubectl plugin list
10+
{{<prompt>}}kubectl krew list
1211
```
1312

14-
To list all plugins installed via Krew, run:
13+
You can list all installed `kubectl` plugins (including those not installed via
14+
Krew) using:
1515

1616
```sh
17-
{{<prompt>}}kubectl krew list
17+
{{<prompt>}}kubectl plugin list
1818
```
1919

2020
### Backing up plugin list
2121

22-
When you pipe or redirect `kubectl krew list` command’s output to another file
22+
When you pipe or redirect the `kubectl krew list` command’s output to another file
2323
or command, it will return a list of plugin names installed, e.g.:
2424

2525
```sh
@@ -29,8 +29,9 @@ whoami
2929
tree
3030
```
3131

32-
You can then [install]({{<ref "install.md">}}) the list of plugins from a file
33-
by feeding the file to the `install` command over standard input (stdin):
32+
You can then [install]({{<ref "install.md">}}) the list of plugins from the file
33+
(on another machine, for example) by feeding the file to the `install` command over
34+
standard input (stdin):
3435

3536
```sh
3637
{{<prompt>}}kubectl krew install < backup.txt

site/content/docs/user-guide/quickstart.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 100
66

77
Krew helps you discover and install [`kubectl` plugins][kpl] on your machine.
88

9-
There are [a lot of][list] `kubectl` plugins you can install and use to enhance
9+
You can install and use [a wide variety of][list] `kubectl` plugins to enhance
1010
your Kubernetes experience.
1111

1212
Let's get started:
@@ -54,7 +54,7 @@ auth-proxy Authentication proxy to a pod or service
5454
{{<prompt>}}kubectl krew uninstall access-matrix
5555
```
5656

57-
This is pretty much all you need to know as a user to use Krew.
57+
This is practically all you need to know to start using Krew.
5858

5959
[kpl]: https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/
6060
[list]: {{< relref "plugins.md" >}}

site/content/docs/user-guide/search.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ weight: 300
55
---
66

77
You can find a list of `kubectl` plugins distributed via Krew [here][list].
8-
However, you can achieve this using the command-line as well.
8+
However, you can find plugins using the command line as well.
99

1010
## Search available plugins
1111

site/content/docs/user-guide/setup/install.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ weight: 200
77
Krew itself is a `kubectl` plugin that is installed and updated via Krew (yes,
88
Krew self-hosts).
99

10-
> ⚠️ **Warning:** krew is only compatible with `kubectl` v1.12 or higher.
10+
> ⚠️ **Warning:** krew is only compatible with `kubectl` v1.12 or later.
1111
1212
- **macOS/Linux**: [bash/zsh](#bash), [fish](#fish)
1313
- **[Windows](#windows)**
@@ -17,7 +17,7 @@ Krew self-hosts).
1717
#### Bash or ZSH shells {#bash}
1818

1919
1. Make sure that `git` is installed.
20-
1. Run this command in your terminal to download and install `krew`:
20+
1. Run this command to download and install `krew`:
2121

2222
```sh
2323
(
@@ -29,7 +29,7 @@ Krew self-hosts).
2929
)
3030
```
3131

32-
1. Add `$HOME/.krew/bin` directory to your PATH environment variable. To do
32+
1. Add the `$HOME/.krew/bin` directory to your PATH environment variable. To do
3333
this, update your `.bashrc` or `.zshrc` file and append the following line:
3434

3535
```sh
@@ -38,7 +38,7 @@ Krew self-hosts).
3838

3939
and restart your shell.
4040

41-
1. Verify running `kubectl krew` works.
41+
1. Run `kubectl krew` to check the installation.
4242

4343
#### Fish shell {#fish}
4444

@@ -56,7 +56,7 @@ Krew self-hosts).
5656
end
5757
```
5858

59-
1. Add `$HOME/.krew/bin` directory to your PATH environment variable. To do
59+
1. Add the `$HOME/.krew/bin` directory to your PATH environment variable. To do
6060
this, update your `config.fish` file and append the following line:
6161

6262
```fish
@@ -65,30 +65,30 @@ Krew self-hosts).
6565

6666
and restart your shell.
6767

68-
1. Verify running `kubectl krew` works.
68+
1. Run `kubectl krew` to check the installation.
6969

7070
## Windows {#windows}
7171

72-
1. Make sure `git` is installed on your system.
72+
1. Make sure `git` is installed.
7373
1. Download `krew.exe` from the [Releases][releases] page to a directory.
74-
1. Launch a command-line window (`cmd.exe`) with elevated privileges (since the installation requires use of symbolic links) and navigate to that directory.
74+
1. Launch a command prompt (`cmd.exe`) with administrator privileges (since the installation requires use of symbolic links) and navigate to that directory.
7575
1. Run the following command to install krew:
7676

7777
```sh
7878
krew install krew
7979
```
8080

81-
1. Add `%USERPROFILE%\.krew\bin` directory to your `PATH` environment variable
81+
1. Add the `%USERPROFILE%\.krew\bin` directory to your `PATH` environment variable
8282
([how?](https://java.com/en/download/help/path.xml))
8383

8484
1. Launch a new command-line window.
85-
1. Verify running `kubectl krew` works.
85+
1. Run `kubectl krew` to check the installation.
8686

8787
[releases]: https://github.com/kubernetes-sigs/krew/releases
8888

8989
## Other package managers
9090

91-
You can alternatively install it via some OS-package managers like Homebrew
91+
You can alternatively install Krew via some OS-package managers like Homebrew
9292
(macOS).
9393

94-
However, we don't actively support that scenario at the moment.
94+
However, that method is not actively supported at this time.

site/content/docs/user-guide/setup/uninstall.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ slug: uninstall
44
weight: 200
55
---
66

7-
To remove Krew and plugins installed altogether, run this on your Linux/macOS machine:
7+
To remove Krew and its associated plugins altogether, run this command on your Linux or macOS machine:
88

99
```sh
1010
{{<prompt>}}rm -rf -- ~/.krew
1111
```
1212

13-
On Windows, remove directory: `%USERPROFILE%\.krew`.
13+
On Windows, remove the `%USERPROFILE%\.krew` directory.
1414

1515
> **Note:** If you installed Krew with another package manager (e.g. Homebrew),
16-
> follow their installations in addition to instructions above.
16+
> follow their instructions for uninstalling in addition to the instructions above.

site/content/docs/user-guide/setup/updates.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@ slug: update
44
weight: 300
55
---
66

7-
Krew will occasionally check if a new version is available to remind you to
7+
Krew will occasionally check if a new version is available and remind you to
88
upgrade to a newer version.
99

10-
This is done by calling the GitHub API, and we do not collect any data from your
11-
machine during this process.
10+
This is done by calling the GitHub API, and the process does not collect any data from your
11+
machine.
1212

1313
If you want to disable the update checks, set the `KREW_NO_UPGRADE_CHECK`
14-
environment variable. To permanently disable this, add the following to your
14+
environment variable. To permanently disable this feature, add the following to your
1515
`~/.bashrc`, `~/.bash_profile`, or `~/.zshrc`:
1616

1717
```shell

site/content/docs/user-guide/upgrade.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,7 @@ slug: upgrading-plugins
44
weight: 600
55
---
66

7-
Plugins you are using might have newer versions available.
8-
9-
If you want to upgrade all plugins to their latest versions, run:
7+
To upgrade all plugins that you have installed to their latest versions, run:
108

119
```sh
1210
{{<prompt>}}kubectl krew upgrade
@@ -15,7 +13,7 @@ If you want to upgrade all plugins to their latest versions, run:
1513
Since Krew itself is a plugin also managed through Krew, running the upgrade
1614
command will also upgrade your `krew` setup to the latest version.
1715

18-
To upgrade only some plugins, you can explicitly specify their name:
16+
To upgrade only certain plugins, you can explicitly specify their names:
1917

2018
```sh
2119
{{<prompt>}}kubectl krew upgrade <PLUGIN1> <PLUGIN2>

site/content/docs/user-guide/using-custom-indexes.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ slug: custom-indexes
44
weight: 800
55
---
66

7-
Plugin indexes contain plugin manifests, which are documents that describe
7+
Plugin indexes contain plugin manifests, which are documents that describe the
88
installation procedure for a plugin. For discovery purposes, Krew comes with a
99
`default` plugin index, plugins hosted in the [`krew-index` repository][ki].
1010

@@ -25,15 +25,15 @@ The URI you use can be any [git remote](https://git-scm.com/docs/git-remote)
2525
## Removing a custom index
2626

2727
You can remove a custom plugin index by passing the name it was added with to
28-
the remove command:
28+
the `index remove` command:
2929

3030
```sh
3131
{{<prompt>}}kubectl krew index remove foo
3232
```
3333

3434
## Listing indexes
3535

36-
To see what indexes you have added run the list command:
36+
To see what indexes you have added run the `index list` command:
3737

3838
```sh
3939
{{<prompt>}}kubectl krew index list
@@ -78,18 +78,17 @@ Similarly:
7878
```
7979
8080
81-
> **Caveat:** If two indexes offer a plugin with the same name, only one can
81+
> **Note:** If two indexes each include a plugin with the same name, only one can
8282
> be installed at any time.
8383
8484
## The default index
8585
86-
When a plugin doesn't have an explicit `INDEX_NAME` prefix, it refers to a plugin
87-
from the `default` index. These plugins have an implicit `default/` prepended to
88-
them in Krew commands. The `INDEX_NAME` prefix is used to differentiate plugins
89-
with the same name across different indexes.
86+
When you don't include an explicit `INDEX_NAME` prefix in your Krew command, the
87+
command will refer to a plugin from the default index. The `INDEX_NAME` prefix is
88+
used to differentiate plugins with the same name across different indexes.
9089

9190
Krew ships with [`krew-index`][ki] as the `default` index, but this can be
92-
removed using the `kubectl krew index remove default` command. Once this is
91+
removed using the `kubectl krew index remove default` command. Once it is
9392
removed, you can add another index with the name `default` and plugins from it
9493
will not require the `INDEX_NAME` prefix in commands.
9594

0 commit comments

Comments
 (0)