From 437e2a74f8516d40e564ffb4437b8bcdd47d17ff Mon Sep 17 00:00:00 2001 From: bhumijgupta Date: Mon, 5 Jul 2021 17:15:04 +0530 Subject: [PATCH] Add info to verify successfull installation and address other suggestions Signed-off-by: bhumijgupta --- .../tasks/tools/included/kubectl-convert-overview.md | 8 +++++--- content/en/docs/tasks/tools/install-kubectl-linux.md | 9 ++++++++- content/en/docs/tasks/tools/install-kubectl-macos.md | 10 +++++++++- content/en/docs/tasks/tools/install-kubectl-windows.md | 10 +++++++++- 4 files changed, 31 insertions(+), 6 deletions(-) diff --git a/content/en/docs/tasks/tools/included/kubectl-convert-overview.md b/content/en/docs/tasks/tools/included/kubectl-convert-overview.md index 7490fc9832..b1799d52ea 100644 --- a/content/en/docs/tasks/tools/included/kubectl-convert-overview.md +++ b/content/en/docs/tasks/tools/included/kubectl-convert-overview.md @@ -1,9 +1,11 @@ --- title: "kubectl-convert overview" -description: "What is kubectl-convert plugin?" +description: >- + A kubectl plugin that allows you to convert manifests from one version + of a Kubernetes API to a different version. headless: true --- -kubectl-convert is a kubectl plugin which allows to convert manifests between different api -versions. This can be particularly helpful to migrate manifests to a non-deprecated api version. +A plugin for Kubernetes command-line tool `kubectl`, which allows you to convert manifests between different API +versions. This can be particularly helpful to migrate manifests to a non-deprecated api version with newer Kubernetes release. For more info, visit [migrate to non deprecated apis](/docs/reference/using-api/deprecation-guide/#migrate-to-non-deprecated-apis) \ No newline at end of file diff --git a/content/en/docs/tasks/tools/install-kubectl-linux.md b/content/en/docs/tasks/tools/install-kubectl-linux.md index f771b9cb0c..099e678a56 100644 --- a/content/en/docs/tasks/tools/install-kubectl-linux.md +++ b/content/en/docs/tasks/tools/install-kubectl-linux.md @@ -184,7 +184,7 @@ Below are the procedures to set up autocompletion for Bash and Zsh. {{< tab name="Zsh" include="included/optional-kubectl-configs-zsh.md" />}} {{< /tabs >}} -### Install kubectl convert plugin +### Install `kubectl convert` plugin {{< include "included/kubectl-convert-overview.md" >}} @@ -231,6 +231,13 @@ Below are the procedures to set up autocompletion for Bash and Zsh. sudo install -o root -g root -m 0755 kubectl-convert /usr/local/bin/kubectl-convert ``` +1. Verify plugin is successfully installed + + ```shell + kubectl convert --help + ``` + + If you do not see an error, it means the plugin is successfully installed. ## {{% heading "whatsnext" %}} diff --git a/content/en/docs/tasks/tools/install-kubectl-macos.md b/content/en/docs/tasks/tools/install-kubectl-macos.md index fed72a6dbd..2b214f6396 100644 --- a/content/en/docs/tasks/tools/install-kubectl-macos.md +++ b/content/en/docs/tasks/tools/install-kubectl-macos.md @@ -168,7 +168,7 @@ Below are the procedures to set up autocompletion for Bash and Zsh. {{< tab name="Zsh" include="included/optional-kubectl-configs-zsh.md" />}} {{< /tabs >}} -### Install kubectl convert plugin +### Install `kubectl convert` plugin {{< include "included/kubectl-convert-overview.md" >}} @@ -236,6 +236,14 @@ Below are the procedures to set up autocompletion for Bash and Zsh. Make sure `/usr/local/bin` is in your PATH environment variable. {{< /note >}} +1. Verify plugin is successfully installed + + ```shell + kubectl convert --help + ``` + + If you do not see an error, it means the plugin is successfully installed. + ## {{% heading "whatsnext" %}} {{< include "included/kubectl-whats-next.md" >}} diff --git a/content/en/docs/tasks/tools/install-kubectl-windows.md b/content/en/docs/tasks/tools/install-kubectl-windows.md index 956eb50a61..ef9f4e5815 100644 --- a/content/en/docs/tasks/tools/install-kubectl-windows.md +++ b/content/en/docs/tasks/tools/install-kubectl-windows.md @@ -140,7 +140,7 @@ Below are the procedures to set up autocompletion for Zsh, if you are running th {{< include "included/optional-kubectl-configs-zsh.md" >}} -### Install kubectl-convert plugin +### Install `kubectl convert` plugin {{< include "included/kubectl-convert-overview.md" >}} @@ -175,6 +175,14 @@ Below are the procedures to set up autocompletion for Zsh, if you are running th 1. Add the binary in to your `PATH`. +1. Verify plugin is successfully installed + + ```shell + kubectl convert --help + ``` + + If you do not see an error, it means the plugin is successfully installed. + ## {{% heading "whatsnext" %}} {{< include "included/kubectl-whats-next.md" >}}