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

Update docs/tasks/tools/install-minikube #23354

Closed
inductor opened this issue Aug 23, 2020 · 16 comments
Closed

Update docs/tasks/tools/install-minikube #23354

inductor opened this issue Aug 23, 2020 · 16 comments
Assignees
Labels
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. language/en Issues or PRs related to English language priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.

Comments

@inductor
Copy link
Member

inductor commented Aug 23, 2020

This is a Feature Request

Install Minikube doesn't follow the latest information where you no longer need a hypervisor in order to use the minikube cluster as the default driver is Docker now.

Ref. https://minikube.sigs.k8s.io/docs/drivers/

What would you like to be added

Update the doc

Why is this needed

It doesn't follow the latest information

Comments
/lang en
/good-first-issue

@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 Aug 23, 2020
@rbrishabh
Copy link

Hey! I would like to work on this! Can you provide more info on what the new docs should say?
Thanks

@inductor
Copy link
Member Author

Install a Hypervisor should be optional and the doc does not mention about Docker driver which is recommended in the official doc(read the ref)

@rbrishabh
Copy link

Okay, got it! Will make a PR soon.
Thanks!

@sftim
Copy link
Contributor

sftim commented Aug 23, 2020

/priority important-longterm
/kind bug
/language en

However, as the work is not clearly defined:
/remove-good-first-issue

@k8s-ci-robot k8s-ci-robot added priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete. kind/bug Categorizes issue or PR as related to a bug. language/en Issues or PRs related to English language and removed good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. labels Aug 23, 2020
@sftim
Copy link
Contributor

sftim commented Aug 23, 2020

I'd replace Install a hypervisor with another section Ensure you have what you need (or similar title).

@celestehorgan
Copy link
Contributor

celestehorgan commented Sep 28, 2020

@rbrishabh doesn't appear to have updated this, and I need a good first issue to train up a new member of CNCF docs/dev advocacy staff, so I'm going to take this one 👍

cc: @hackabletype. Please comment on this issue with /assign to assign yourself.

(nb. Nate: hold. Do not action on this until we meet later this afternoon.)

@k8s-ci-robot
Copy link
Contributor

@celestehorgan: GitHub didn't allow me to assign the following users: hackabletype.

Note that only kubernetes members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time.
For more information please see the contributor guide

In response to this:

@rbrishabh doesn't appear to have updated this, and I need a good first issue to train up a new member of CNCF docs/dev advocacy staff, so I'm going to take this one 👍

/assign @hackabletype

(nb. Nate: hold. Do not action on this until we meet later this afternoon.)

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.

@rbrishabh
Copy link

Sorry! I got busy with other work! Please feel free to work on this, thanks!

@nate-double-u
Copy link
Contributor

/assign

@nate-double-u
Copy link
Contributor

Hi @inductor, based on another conversation, we may solve this issue by removing the minikube installation as dual sourced content, and replacing this page with a link to the minikube installer documentation.

@tstromberg we are thinking of removing this page and replacing it with a link to minikube installer documentation. Do you think this is appropriate y/n?

@celestehorgan
Copy link
Contributor

@hackabletype

As a part of this change, it might be worth making the links to Kind and Minikube a bit more visual/see-able. For example, using a button like here: https://kubernetes.io/docs/home/#understand-the-basics

@nate-double-u
Copy link
Contributor

Karen B shared this PR in the Sig-Docs weekly meeting: #20717. It looks like it does the page trimming that we're looking at doing in this issue.

nate-double-u added a commit to nate-double-u/kubernetes-website that referenced this issue Oct 7, 2020
… installation as dual sourced content, and replacing this page with a link to the minikube installer documentation.

Removing content/en/docs/tasks/tools/install-minikube.md file.
Updating content/en/docs/tasks/tools/_index.mb file to link out directly to the minikube.sigs.k8s.io getting started page using @celestehorgan's button suggestion. Updating other sections to link out using buttons to keep consistency across the page.

Signed-off-by: Nate W <[email protected]>
nate-double-u added a commit to nate-double-u/kubernetes-website that referenced this issue Oct 7, 2020
As per conversations in issue kubernetes#23354,
* Removing content/en/docs/tasks/tools/install-minikube.md page
* Updating content/en/docs/tasks/tools/_index.md with @celestehorgan's suggestion to add buttons to make these links more visual/see-able

Signed-off-by: Nate W <[email protected]>
nate-double-u added a commit to nate-double-u/kubernetes-website that referenced this issue Oct 7, 2020
As per conversations in issue kubernetes#23354,
* Removing content/en/docs/tasks/tools/install-minikube.md page
* Updating content/en/docs/tasks/tools/_index.md with the suggestion to add buttons to make these links more visual/see-able

Signed-off-by: Nate W <[email protected]>
@sftim
Copy link
Contributor

sftim commented Oct 8, 2020

nate-double-u added a commit to nate-double-u/kubernetes-website that referenced this issue Oct 8, 2020
As per conversations in issue kubernetes#23354,
* Removing content/en/docs/tasks/tools/install-minikube.md page
* Updating content/en/docs/tasks/tools/_index.md with the suggestion to add buttons to make these links more visual/see-able
* Adding a 307 temporary redirect for /docs/tasks/tools/install-minikube/

Signed-off-by: Nate W <[email protected]>
nate-double-u added a commit to nate-double-u/kubernetes-website that referenced this issue Oct 8, 2020
As per conversations in issue kubernetes#23354,
* Removing content/en/docs/tasks/tools/install-minikube.md page
* Updating content/en/docs/tasks/tools/_index.md with the suggestion to add buttons to make these links more visual/see-able, including aria-labels
* Adding a 307 temporary redirect for /docs/tasks/tools/install-minikube/

Signed-off-by: Nate W <[email protected]>
nate-double-u added a commit to nate-double-u/kubernetes-website that referenced this issue Oct 9, 2020
As per conversations in issue kubernetes#23354,
* Removing content/en/docs/tasks/tools/install-minikube.md page
* Adding a 302 temporary redirect for /docs/tasks/tools/install-minikube/

Additionally:
* Updating content/en/docs/tasks/tools/_index.md with the suggestion to add buttons to make these links more visual/see-able, including aria-labels
* Updating minikube capitalization throughout page
* Updating text throughout page for line length

Signed-off-by: Nate W <[email protected]>
nate-double-u added a commit to nate-double-u/kubernetes-website that referenced this issue Oct 9, 2020
As per conversations in issue kubernetes#23354,
* Removing content/en/docs/tasks/tools/install-minikube.md page
* Adding a 302 temporary redirect for /docs/tasks/tools/install-minikube/
* Updating content/en/docs/tasks/tools/_index.md with the suggestion to add buttons to make these links more visual/see-able, including aria-labels

Additionally:
* Updating minikube capitalization throughout page
* Updating text throughout page for line length
* Correcting back ticks use throughout page

Signed-off-by: Nate W <[email protected]>
@nate-double-u
Copy link
Contributor

Should we also amend / remove https://k8s.io/docs/setup/learning-environment/minikube/ and https://k8s.io/docs/setup/learning-environment/kind/ ?

Revising my previous comment, now removed:

@sftim
Copy link
Contributor

sftim commented Nov 29, 2020

The page at https://kubernetes.io/docs/tasks/tools/install-minikube/ is gone.
/close

@k8s-ci-robot
Copy link
Contributor

@sftim: Closing this issue.

In response to this:

The page at https://kubernetes.io/docs/tasks/tools/install-minikube/ is gone.
/close

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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. language/en Issues or PRs related to English language priority/important-longterm Important over the long term, but may not be staffed and/or may need multiple releases to complete.
Projects
None yet
Development

No branches or pull requests

6 participants