kubernetes/website

Issue with k8s.io/docs/tasks/tools/: Difference between Minikube and Kind is not clear

Open

#31,186 opened on Jan 3, 2022

View on GitHub
 (35 comments) (1 reaction) (1 assignee)HTML (13,918 forks)batch import
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/_redirects that 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 kubectl as well (and link to https://kubernetes.io/docs/tasks/tools/#kubectl)
  • a phrase like “if you're not sure, pick Minikube” is appropriate
  • 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 kind is 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/

Contributor guide