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

Reconcile the minikube install page with best practices #20717

Closed
wants to merge 6 commits into from

Conversation

tstromberg
Copy link
Contributor

@tstromberg tstromberg commented May 1, 2020

Update the minikube installation document to be in-line with the guidance we provide users at https://minikube.sigs.k8s.io/docs/start/

Preview URL: https://deploy-preview-20717--kubernetes-io-master-staging.netlify.app/docs/tasks/tools/install-minikube/

Specific changes:

  • fix capitalization of "minikube"
  • remove obsolete guidance:
    • virtualization is no longer required by minikube
    • neither is kubectl (though handy)
    • Linux packages are no longer experimental
  • Remove the non-installation steps, as they are covered by the "next steps" document (which will be further improved in a subsequent PR)

Related issues:

/cc @zacharysarah @afbjorklund @prasadkatti @medyagh @priyawadhwa @sharifelgamal

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels May 1, 2020
@k8s-ci-robot 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 May 1, 2020
@netlify
Copy link

netlify bot commented May 2, 2020

Deploy preview for kubernetes-io-master-staging ready!

Built with commit 046216e

https://deploy-preview-20717--kubernetes-io-master-staging.netlify.app

Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tstromberg here's some feedback - I hope it's useful.

I'm happy to take another look when you're ready for that.

content/en/docs/tasks/tools/install-minikube.md Outdated Show resolved Hide resolved
content/en/docs/tasks/tools/install-minikube.md Outdated Show resolved Hide resolved
content/en/docs/tasks/tools/install-minikube.md Outdated Show resolved Hide resolved
content/en/docs/tasks/tools/install-minikube.md Outdated Show resolved Hide resolved
content/en/docs/tasks/tools/install-minikube.md Outdated Show resolved Hide resolved
content/en/docs/tasks/tools/install-minikube.md Outdated Show resolved Hide resolved
@sftim
Copy link
Contributor

sftim commented May 2, 2020

/sig minikube

@k8s-ci-robot
Copy link
Contributor

@sftim: The label(s) sig/minikube cannot be applied, because the repository doesn't have them

In response to this:

/sig minikube

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.

@bradtopol
Copy link
Contributor

/assign @sftim

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign sftim
You can assign the PR to them by writing /assign @sftim in a comment when ready.

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

Needs approval from an approver in each of these files:

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

@kbhawkey
Copy link
Contributor

kbhawkey commented May 7, 2020

@tstromberg, Changes look okay.
I am wondering if you need to say more about what happens when you run,
minikube start.
What is the reason for removing the cleanup instructions?

@tstromberg
Copy link
Contributor Author

@tstromberg, Changes look okay.
I am wondering if you need to say more about what happens when you run,
minikube start.

Do you have any suggestions? From my vantage point it seems self explanatory given the surrounding context, both from the documentation and the command output.

What is the reason for removing the cleanup instructions?

This is just an installation doc, the guide for managing your cluster should be captured by the "whatsnext" link (which I also intend to update once this doc is approved)

@kbhawkey
Copy link
Contributor

kbhawkey commented May 8, 2020

@tstromberg ,
What you have is okay, just thought some text would help tie in the start command and the
driver text. Here are some ideas:

## Starting your first cluster

minikube will automatically select an appropriate driver, but will mention alternatives if available.
To start your cluster, run:

minikube start

To stop your cluster, run:

minikube stop

For additional information or assistance about minikube, reach out on the
minikube Slack channel #minikube.

## What's next

* [Run Kubernetes locally with minikube](...)
* Read the [minikube documentation][minikube.sigs.k8s.io/docs)

@kbhawkey
Copy link
Contributor

@tstromberg . Is this pull request ready? If so, please squash your commits. Thanks!

@jimangel
Copy link
Member

@tstromberg thanks for the PR! Do you have interest in resolving the conflicts and addressing the feedback? Given the time this PR has been open, the next PR wrangler may close this if there's no action. Thanks!

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jun 10, 2020
@k8s-ci-robot
Copy link
Contributor

@tstromberg: PR needs rebase.

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.

@tengqm
Copy link
Contributor

tengqm commented Jun 13, 2020

Okay to close? @tstromberg

@sftim
Copy link
Contributor

sftim commented Jun 21, 2020

@tstromberg if you want to update that page and open a new PR from your branch, go ahead (and please mention that the new PR is a continuation of #20717).

You'll need to rebase your branch against master BTW.

@sftim
Copy link
Contributor

sftim commented Jun 21, 2020

/close

@k8s-ci-robot
Copy link
Contributor

@sftim: Closed this PR.

In response to this:

/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
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. language/en Issues or PRs related to English language needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants