Community: Most guides are not detailed enough

[erikbgithub]

For instance this one: https://github.com/kubernetes/community/blob/master/contributors/devel/local-cluster/docker.md

It basically says "run hyperkube with these params" and even after an update it's mostly "don't do this any more, use minikube instead" while the minikube again just says "run minikube with these params".

This kind of article doesn't do any good, because people run into problems. And when they do that and are paid to continue anyways, they want to understand how the stuff works underneath. We need such guides to explain what happens underneath as well to replicate the behaviour manually or see at a failing step in the helper tool how to debug it.

[calvn]

Another case is on the Getting started locally guide, where it mentions running the setup with minikube if not on Linux, but does not actually provide any steps or configuration on how things should be set up for that scenario.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

Prevent issues from auto-closing with an /lifecycle frozen comment.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or @fejta.
/lifecycle stale

[fejta-bot]

Stale issues rot after 30d of inactivity.
Mark the issue as fresh with /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle rotten
/remove-lifecycle stale

[nikhita]

I guess this is still relevant.

/remove-lifecycle rotten

@castrojo Not sure if this is being tracked elsewhere (for the contributor guide). If it is, please feel free to close it. :)

[erikbgithub]

I also think it's still relevant, but I've moved on to Openshift, so I'm not really in the know anymore and will unsubscribe. Thanks for continue to working on it, though. Documentation is always one of the hardest parts.

[fejta-bot]

Issues go stale after 90d of inactivity.
Mark the issue as fresh with /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.

If this issue is safe to close now please do so with /close.

Send feedback to sig-testing, kubernetes/test-infra and/or fejta.
/lifecycle stale

[nikhita]

/remove-lifecycle stale
/lifecycle frozen

[nikhita]

/area developer-guide
/cc @eduartua

[mrbobbytables]

I think at this point with our contributor guide we should be good. We have a planned rework for at least development.md that is being tracked here:
https://github.com/kubernetes/community/issues/1644

With that I'm going to go ahead and close this out for now 👍
If you think it should be left open, please feel free to reply here or poke me in slack.

Thanks!
/close

[k8s-ci-robot]

@mrbobbytables: Closing this issue.

In response to this:

I think at this point with our contributor guide we should be good. We have a planned rework for at least development.md that is being tracked here:
https://github.com/kubernetes/community/issues/1644

With that I'm going to go ahead and close this out for now 👍
If you think it should be left open, please feel free to reply here or poke me in slack.

Thanks!
/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.