kubernetes/website
View on GitHubIssue with k8s.io/docs/tasks/tools/: Difference between Minikube and Kind is not clear
Open
#31,186 opened on Jan 3, 2022
help wantedlanguage/entriage/accepted
Repository metrics
- Stars
- (4,127 stars)
- PR merge metrics
- (Avg merge 16d 13h) (160 merged PRs in 30d)
Description
On this page it is not clear why there are two tools: Minikube and Kind:
https://kubernetes.io/docs/tasks/tools/
This confuses new users.
[extra details added by @sftim] Here's how someone could fix that:
- instead, we write a new page that lists different ways to set up a learning environment
- the new page would have the URL https://kubernetes.io/docs/setup/learning-environment/ (replacing the existing stub)
- there is a redirect in
static/_redirectsthat you must remove - the page should help people choose what environment to select based on what they want to learn
- there should be a mix of signposting and summaries to help people understand what a Kubernetes is, because the target audience is clearly still learning
- make it clear that people should install
kubectlas well (and link to https://kubernetes.io/docs/tasks/tools/#kubectl) - a phrase like “if you're not sure, pick Minikube” is appropriate
kindrequires that you have either Docker or Podman installed, and maybe that isn't what you wantedkubeadminstalls are a lot to cover for a beginner and also link to https://kubernetes.io/docs/tutorials/hello-minikube/ so that people know what to do next
- as well as the simple option, add more details for people who want to know more, behind a
<details>element.- if you don't reveal the details option, the page signposts you to set up minikube and kubectl
- if you do reveal the details option, the page tells you that
kindis another common choice, then gives readers more information to help them choose an approach based on their needs. - it's OK to link to external guides where these are appropriate for readers' needs and we can have reasonable confidence that these links will stay relevant
Optional extra improvements: update https://minikube.sigs.k8s.io/docs/start/ to link back to https://kubernetes.io/docs/tutorials/hello-minikube/
- optionally, we can also mention that there are proprietary options and link to a selection.
- be wary of confusing people if linking to Docker Desktop!
- optionally, also link to https://github.com/kelseyhightower/kubernetes-the-hard-way, or to a shortlink that we set up for the purpose (eg https://k8s.io/kubernetes-the-hard-way)
- maybe there's a curated list of alternatives; Kelsey Hightower's original is GCP specific
- link to https://k8s.io/docs/setup/production-environment/ - ideally written so people are clear that there's more to learn later and, actually, that they don't need to learn it all right away.