Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add build instructions for the impatient #38504

Merged
merged 1 commit into from
Dec 15, 2016
Merged

Add build instructions for the impatient #38504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
28 changes: 25 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Kubernetes builds upon a decade and a half of experience at Google running produ
### Are you ...

* Interested in learning more about using Kubernetes?
- See see our documentation on [kubernetes.io](http://kubernetes.io)
- See our documentation on [kubernetes.io](http://kubernetes.io)
- Try our [interactive tutorial](http://kubernetes.io/docs/tutorials/kubernetes-basics/)
- Take a free course on [Scalable Microservices with Kubernetes](https://www.udacity.com/course/scalable-microservices-with-kubernetes--ud615).
* Interested in developing the core Kubernetes code base, developing tools using the Kubernetes API or helping in anyway possible ? Keep reading!
Expand All @@ -50,14 +50,36 @@ Join a Special Interest Group ([SIG](https://github.com/kubernetes/community))

If you're interested in being a contributor and want to get involved in developing Kubernetes, get started with with this reading:

* The community [expectations](docs/devel/community-expectations.md)
* The community [expectations](https://github.com/kubernetes/community/blob/master/contributors/devel/community-expectations.md)
* The [contributor guidelines](CONTRIBUTING.md)
* The [Kubernetes Developer Guide](docs/devel/README.md)
* The [Kubernetes Developer Guide](https://github.com/kubernetes/community/tree/master/contributors/devel)

You will then most certainly gain a lot from joining a [SIG](https://github.com/kubernetes/community), attending the regular hangouts as well as the community [meeting](https://github.com/kubernetes/community/blob/master/community/README.md).

If you have an idea for a new feature, see the [Kubernetes Features](https://github.com/kubernetes/features) repository for a list of features that are coming in new releases as well as details on how to propose one.

### Building Kubernetes for the impatient

If you want to build Kubernetes right away there are two options:

* You have a working [Go environment](https://golang.org/doc/install).

```
$ go get -d k8s.io/kubernetes
$ cd $GOPATH/src/k8s.io/kubernetes
$ make
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am impressed and happy that this now works without having to manually go get more tooling.

I'm not sure if this is something to be fixed, but when I do the initial go get, I see some output:

$ go get k8s.io/kubernetes
package k8s.io/kubernetes: no buildable Go source files in /root/go/src/k8s.io/kubernetes
$

Not sure if we want to mention it, or find a way to clean it up. (Maybe it's understood that this will happen?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess we could do go get -d k8s.io/kubernetes that should avoid the warning message as it won't try to build.

```

* You have a working [Docker environment](https://docs.docker.com/engine/).

```
$ git clone https://github.com/kubernetes/kubernetes
$ cd kubernetes
$ make quick-release
```

If you are less impatient, head over to the [developer's documentation](https://github.com/kubernetes/community/tree/master/contributors/devel).

## Support

While there are many different channels that you can use to get hold of us ([Slack](http://slack.k8s.io/), [Stack Overflow](http://stackoverflow.com/questions/tagged/kubernetes), [Issues](https://github.com/kubernetes/kubernetes/issues/new), [Forums/Mailing lists](https://groups.google.com/forum/#!forum/kubernetes-users)), you can help make sure that we are efficient in getting you the help that you need.
Expand Down