Missing Step in Documentation for Building Kubernetes in Docker about kubernetes HOT 8 OPEN

/triage accepted

from kubernetes.

@this-is-yaash: The label(s) sig/sig/docs cannot be applied, because the repository doesn't have them.

from kubernetes.

/sig docs

from kubernetes.

/kind documentation

from kubernetes.

/assign

from kubernetes.

You're not expected to be starting from this file, we have a broader developer guide.

https://www.kubernetes.dev/docs/guide/

At most we should put a brief pointer, we should not duplicate the docs for setting up your local clone, it is implied that you have to have a checkout.

The clone should be implied here, it is expected that to build an open source project on github you must have the source code locally, and the same for running scripts from the repo.

from kubernetes.

https://github.com/kubernetes/kubernetes/blob/master/CONTRIBUTING.md (github standard contributing guide location) which links to https://github.com/kubernetes/community/tree/master/contributors/guide, which will later link to the building docs after cloning etc.

We should probably add a link in the building doc in this repo to this step: https://github.com/kubernetes/community/tree/master/contributors/guide#setting-up-your-development-environment

And maybe also a pointer to CONTRIBUTING.md as that's a better entrypoint if you're planning to contribute.

from kubernetes.

/remove-sig docs
/sig release contributor-experience

(SIG docs maintains kubernetes.io, they don't necessarily maintain all documentation in the project, such as the contributor guides, which are contribex or the SIGs for which the development is being done)

from kubernetes.