Update docs to reflect newly support shells with autocompletions #29610

zikhan · 2021-09-03T00:35:52Z

Update Windows docs to use Powershell instead of zsh

Reflect changes made in kubernetes/kubernetes#103758 & kubernetes/kubernetes#92989

I'm not well versed in fish, so I'll leave that part for someone else to get an easy contribution in.

* Update Windows docs to use Powershell instead of zsh

k8s-ci-robot · 2021-09-03T00:36:00Z

Welcome @zikhan!

It looks like this is your first PR to kubernetes/website 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/website has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

geoffcline

thanks for the PR!

content/en/docs/tasks/tools/included/optional-kubectl-configs-pwsh.md

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

geoffcline · 2021-09-07T03:18:44Z

adding a /lgtm despite my membership still pending

PI-Victor · 2021-09-09T11:59:29Z

/hold
is this really supposed to be open against dev-1.23?
/cc @jlbutler

geoffcline · 2021-09-09T15:46:40Z

I appreciated @zikhan s comment that the existing instructions are quite outdated. How about we wrap the new instructions with some sort of version flag?

Could you use the newest version of kubectl be used with existing clusters on an older version? I think so, as a novice, but we may not want to recommend this behavior.

eddiezane · 2021-09-09T18:42:58Z

/hold
is this really supposed to be open against dev-1.23?
/cc @jlbutler

I'm not sure about the branch logistics but powershell and fish won't ship until 1.23 so shouldn't be live before then.

PI-Victor · 2021-09-09T20:27:17Z

/hold

is this really supposed to be open against dev-1.23?

/cc @jlbutler

I'm not sure about the branch logistics but powershell and fish won't ship until 1.23 so shouldn't be live before then.

that answers my question, thank you!

/milestone 1.23

the hold can be lifted by a reviewer from docs release whenever it's done

sftim

I proposed some capitalization corrections. Also needs a tech LGTM, which is essentially confirming that the code does offer these completions (and so, should be easy to find).

content/en/docs/tasks/tools/included/optional-kubectl-configs-pwsh.md

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

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

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

Co-authored-by: Tim Bannister <tim@scalefactory.com>

zikhan · 2021-09-10T16:43:46Z

I proposed some capitalization corrections. ...

@sftim I've made the changes you've proposed.

geoffcline · 2021-09-10T21:21:55Z

I have verified the instructions work on Windows Server 2019 and kubectl built from k/k/main

/lgtm

k8s-ci-robot · 2021-09-10T21:22:14Z

LGTM label has been added.

Git tree hash: e0d48fbbfbf5f3c136ea364e7705ec875f8434cc

tengqm · 2021-09-12T00:59:09Z

/label tide/merge-method-squash

tengqm · 2021-09-12T00:59:28Z

/approve

k8s-ci-robot · 2021-09-12T00:59:51Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tengqm

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~content/en/OWNERS~~ [tengqm]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

sftim

/hold cancel

@zikhan: if you want to, you can open an extra PR to mention the PowerShell autocomplete on macOS and Linux (I think that would be a good idea).

sftim · 2021-09-12T09:53:19Z

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

@@ -176,7 +176,7 @@ kubectl version --client

 ### Enable shell autocompletion

-kubectl provides autocompletion support for Bash and Zsh, which can save you a lot of typing.
+kubectl provides autocompletion support for Bash, Zsh, Fish, and PowerShell, which can save you a lot of typing.

 Below are the procedures to set up autocompletion for Bash and Zsh.


We could also add a tab here for PowerShell.

As these are third party tools, if we do, I would add the PowerShell tab before Zsh.

sftim · 2021-09-12T09:53:23Z

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

@@ -159,7 +159,7 @@ If you are on macOS and using [Macports](https://macports.org/) package manager,

 ### Enable shell autocompletion

-kubectl provides autocompletion support for Bash and Zsh, which can save you a lot of typing.
+kubectl provides autocompletion support for Bash, Zsh, Fish, and PowerShell which can save you a lot of typing.

 Below are the procedures to set up autocompletion for Bash and Zsh.


We could also add a tab here for PowerShell.

As these are third party tools, if we do, I would add the PowerShell tab before Zsh.

…ernetes#29610) * Update docs to reflect newly support shells with autocompletions * Update Windows docs to use Powershell instead of zsh * Adds a bit more explanation of the different lines. * Apply suggestions from code review Co-authored-by: Tim Bannister <tim@scalefactory.com> * Apply PR suggestions Co-authored-by: Tim Bannister <tim@scalefactory.com>

Update docs to reflect newly support shells with autocompletions

d8527f1

* Update Windows docs to use Powershell instead of zsh

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Sep 3, 2021

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Sep 3, 2021

k8s-ci-robot requested review from mikedanese and sftim September 3, 2021 00:36

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. labels Sep 3, 2021

geoffcline reviewed Sep 3, 2021

View reviewed changes

content/en/docs/tasks/tools/included/optional-kubectl-configs-pwsh.md Outdated Show resolved Hide resolved

content/en/docs/tasks/tools/install-kubectl-windows.md Outdated Show resolved Hide resolved

Adds a bit more explanation of the different lines.

96dfbc6

k8s-ci-robot requested a review from jlbutler September 9, 2021 11:59

k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 9, 2021

k8s-ci-robot added this to the 1.23 milestone Sep 9, 2021

sftim reviewed Sep 10, 2021

View reviewed changes

zikhan and others added 2 commits September 10, 2021 09:36

Apply suggestions from code review

5cb0e49

Co-authored-by: Tim Bannister <tim@scalefactory.com>

Apply PR suggestions

3710b1e

k8s-ci-robot assigned geoffcline Sep 10, 2021

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Sep 10, 2021

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Sep 12, 2021

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Sep 12, 2021

sftim reviewed Sep 12, 2021

View reviewed changes

k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Sep 12, 2021

k8s-ci-robot merged commit c189c2d into kubernetes:dev-1.23 Sep 12, 2021

Aankhen mentioned this pull request Nov 27, 2021

It does not seem to autocomplete namespace name mziyabo/PSKubectlCompletion#7

Closed

dhirschfeld mentioned this pull request Nov 30, 2021

Install shell completions conda-forge/kubernetes-feedstock#93

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs to reflect newly support shells with autocompletions #29610

Update docs to reflect newly support shells with autocompletions #29610

zikhan commented Sep 3, 2021

k8s-ci-robot commented Sep 3, 2021

geoffcline left a comment

geoffcline commented Sep 7, 2021

PI-Victor commented Sep 9, 2021

geoffcline commented Sep 9, 2021 •

edited

eddiezane commented Sep 9, 2021

PI-Victor commented Sep 9, 2021

sftim left a comment

zikhan commented Sep 10, 2021 •

edited

geoffcline commented Sep 10, 2021

k8s-ci-robot commented Sep 10, 2021

tengqm commented Sep 12, 2021

tengqm commented Sep 12, 2021

k8s-ci-robot commented Sep 12, 2021

sftim left a comment

sftim Sep 12, 2021

sftim Sep 12, 2021

Update docs to reflect newly support shells with autocompletions #29610

Update docs to reflect newly support shells with autocompletions #29610

Conversation

zikhan commented Sep 3, 2021

k8s-ci-robot commented Sep 3, 2021

geoffcline left a comment

Choose a reason for hiding this comment

geoffcline commented Sep 7, 2021

PI-Victor commented Sep 9, 2021

geoffcline commented Sep 9, 2021 • edited

eddiezane commented Sep 9, 2021

PI-Victor commented Sep 9, 2021

sftim left a comment

Choose a reason for hiding this comment

zikhan commented Sep 10, 2021 • edited

geoffcline commented Sep 10, 2021

k8s-ci-robot commented Sep 10, 2021

tengqm commented Sep 12, 2021

tengqm commented Sep 12, 2021

k8s-ci-robot commented Sep 12, 2021

sftim left a comment

Choose a reason for hiding this comment

sftim Sep 12, 2021

Choose a reason for hiding this comment

sftim Sep 12, 2021

Choose a reason for hiding this comment

geoffcline commented Sep 9, 2021 •

edited

zikhan commented Sep 10, 2021 •

edited