Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation bug in "using-wsl2.md" #1977

Closed
alandixon opened this issue Dec 14, 2020 · 14 comments · Fixed by #1994
Closed

Documentation bug in "using-wsl2.md" #1977

alandixon opened this issue Dec 14, 2020 · 14 comments · Fixed by #1994
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug.

Comments

@alandixon
Copy link

alandixon commented Dec 14, 2020

Sorry, not really a bug, but the best label fit available.

Documentation bug in kind/site/content/docs/user/using-wsl2.md
(https://github.com/kubernetes-sigs/kind/blob/master/site/content/docs/user/using-wsl2.md)

At the bottom of the document in the paragraph "Helpful Tips for WSL2"
Your proposed approach "wsl distro --shutdown" throws an error: "/bin/bash: distro: command not found".

You shutdown a distro with
wsl --shutdown <distro>

i.e. the parameter order needs to be reversed.
This is incorrect, see my comment below

@alandixon alandixon added the kind/bug Categorizes issue or PR as related to a bug. label Dec 14, 2020
@BenTheElder
Copy link
Member

Would you mind sending a PR? WSL2 support is fully community maintained, none of the maintainers are using it currently.

@aojea
Copy link
Contributor

aojea commented Dec 15, 2020

/good-first-issue
/help wanted
@alandixon should I assign it to you?

@k8s-ci-robot
Copy link
Contributor

@aojea:
This request has been marked as suitable for new contributors.

Please ensure the request meets the requirements listed here.

If this request no longer meets these requirements, the label can be removed
by commenting with the /remove-good-first-issue command.

In response to this:

/good-first-issue
/help wanted
@alandixon should I assign it to you?

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. labels Dec 15, 2020
@alandixon
Copy link
Author

alandixon commented Dec 15, 2020 via email

@alandixon
Copy link
Author

alandixon commented Dec 15, 2020 via email

@aojea
Copy link
Contributor

aojea commented Dec 15, 2020

/assign @alandixon

@BenTheElder
Copy link
Member

Er sorry for the jargon / acronym! Pull request, a patch on GitHub 😅
If not, we can get to it ourselves eventually as well, docs are important! Currently chasing #1969

@gunadhya
Copy link
Contributor

Hi @aojea, I'd like to fix this documentaion bug.

@aojea
Copy link
Contributor

aojea commented Dec 29, 2020

@gunadhya go for it, worst case we have 2 PRS ...

@aojea
Copy link
Contributor

aojea commented Dec 29, 2020

is there any person using WSL that can confirm what is the right command?
This issue says that --shutdown doesn't accept any argument microsoft/WSL#4539

@alandixon
Copy link
Author

The fix is in my original comment.
This was assigned to me but I was completely unable to push the change back up - it kept giving me an error.
I followed the instructions about signing the CNCF CLA etc. but gave up when that didn't work - it all seemed a bit much for a tiny doc change.
Sorry, I should have unassigned myself earlier - @gunadhya feel free to take this.

@alandixon alandixon removed their assignment Dec 29, 2020
@aojea
Copy link
Contributor

aojea commented Dec 29, 2020

Thanks Alan

@alandixon
Copy link
Author

After all that, I got it wrong anyway :(
Running wsl -? to see the available commands gives

    --shutdown
        Immediately terminates all running distributions and the WSL 2 lightweight utility virtual machine.
    --terminate, -t <Distro>
        Terminates the specified distribution.

i.e. it's --terminate to shutdown a specific distro, not --shutdown

@aojea
Copy link
Contributor

aojea commented Dec 29, 2020

why does this work then?
#1994 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. help wanted Denotes an issue that needs help from a contributor. Must meet "help wanted" guidelines. kind/bug Categorizes issue or PR as related to a bug.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants