Missing Step in Documentation for Building Kubernetes in Docker

[this-is-yaash]

Description

I noticed that the documentation for building Kubernetes in Docker does not include a step to clone the Kubernetes repository. The instructions go straight to executing key scripts, which can be confusing for users who are new to the process. That includes me too, when I'm on-boarding it.

Documentation:

• Follow the building Kubernetes in Docker guide.
• Notice that there is no mention of cloning the repository before executing the scripts.

To Make It Better and Understandable to Beginners

To add the follow steps

Cloning the Kubernetes Repository

Before you start building Kubernetes in Docker, make sure to clone the repository using the following command:

git clone https://github.com/kubernetes/kubernetes.git
cd kubernetes

With this, the upcoming guidelines are way too easy to understand after going through this.

[k8s-ci-robot]

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

In response to this:

/sig sig/docs

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-sigs/prow repository.

[this-is-yaash]

/sig docs

[this-is-yaash]

/kind documentation

[this-is-yaash]

/assign

[mengjiao-liu]

/triage accepted

[BenTheElder]

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.

[BenTheElder]

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.

[BenTheElder]

/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)