Skip to content

Commit 437e2a7

Browse files
committed
Add info to verify successfull installation and address other suggestions
Signed-off-by: bhumijgupta <[email protected]>
1 parent 956eb48 commit 437e2a7

File tree

4 files changed

+31
-6
lines changed

4 files changed

+31
-6
lines changed
Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
---
22
title: "kubectl-convert overview"
3-
description: "What is kubectl-convert plugin?"
3+
description: >-
4+
A kubectl plugin that allows you to convert manifests from one version
5+
of a Kubernetes API to a different version.
46
headless: true
57
---
68

7-
kubectl-convert is a kubectl plugin which allows to convert manifests between different api
8-
versions. This can be particularly helpful to migrate manifests to a non-deprecated api version.
9+
A plugin for Kubernetes command-line tool `kubectl`, which allows you to convert manifests between different API
10+
versions. This can be particularly helpful to migrate manifests to a non-deprecated api version with newer Kubernetes release.
911
For more info, visit [migrate to non deprecated apis](/docs/reference/using-api/deprecation-guide/#migrate-to-non-deprecated-apis)

content/en/docs/tasks/tools/install-kubectl-linux.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Below are the procedures to set up autocompletion for Bash and Zsh.
184184
{{< tab name="Zsh" include="included/optional-kubectl-configs-zsh.md" />}}
185185
{{< /tabs >}}
186186

187-
### Install kubectl convert plugin
187+
### Install `kubectl convert` plugin
188188

189189
{{< include "included/kubectl-convert-overview.md" >}}
190190

@@ -231,6 +231,13 @@ Below are the procedures to set up autocompletion for Bash and Zsh.
231231
sudo install -o root -g root -m 0755 kubectl-convert /usr/local/bin/kubectl-convert
232232
```
233233

234+
1. Verify plugin is successfully installed
235+
236+
```shell
237+
kubectl convert --help
238+
```
239+
240+
If you do not see an error, it means the plugin is successfully installed.
234241

235242
## {{% heading "whatsnext" %}}
236243

content/en/docs/tasks/tools/install-kubectl-macos.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Below are the procedures to set up autocompletion for Bash and Zsh.
168168
{{< tab name="Zsh" include="included/optional-kubectl-configs-zsh.md" />}}
169169
{{< /tabs >}}
170170

171-
### Install kubectl convert plugin
171+
### Install `kubectl convert` plugin
172172

173173
{{< include "included/kubectl-convert-overview.md" >}}
174174

@@ -236,6 +236,14 @@ Below are the procedures to set up autocompletion for Bash and Zsh.
236236
Make sure `/usr/local/bin` is in your PATH environment variable.
237237
{{< /note >}}
238238

239+
1. Verify plugin is successfully installed
240+
241+
```shell
242+
kubectl convert --help
243+
```
244+
245+
If you do not see an error, it means the plugin is successfully installed.
246+
239247
## {{% heading "whatsnext" %}}
240248

241249
{{< include "included/kubectl-whats-next.md" >}}

content/en/docs/tasks/tools/install-kubectl-windows.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Below are the procedures to set up autocompletion for Zsh, if you are running th
140140

141141
{{< include "included/optional-kubectl-configs-zsh.md" >}}
142142

143-
### Install kubectl-convert plugin
143+
### Install `kubectl convert` plugin
144144

145145
{{< include "included/kubectl-convert-overview.md" >}}
146146

@@ -175,6 +175,14 @@ Below are the procedures to set up autocompletion for Zsh, if you are running th
175175
176176
1. Add the binary in to your `PATH`.
177177
178+
1. Verify plugin is successfully installed
179+
180+
```shell
181+
kubectl convert --help
182+
```
183+
184+
If you do not see an error, it means the plugin is successfully installed.
185+
178186
## {{% heading "whatsnext" %}}
179187

180188
{{< include "included/kubectl-whats-next.md" >}}

0 commit comments

Comments
 (0)