|
1 | 1 | [](https://travis-ci.org/kubernetes-sigs/kubebuilder "Travis")
|
2 | 2 | [](https://goreportcard.com/report/github.com/kubernetes-sigs/kubebuilder)
|
3 | 3 |
|
4 |
| -*Don't use `go get` / `go install`, instead you MUST download a tar binary release or create your own release using |
5 |
| -the release program.* To build your own release see [CONTRIBUTING.md](CONTRIBUTING.md) |
6 |
| - |
7 |
| -## `kubebuilder` |
| 4 | +## Kubebuilder |
8 | 5 |
|
9 | 6 | Kubebuilder is a framework for building Kubernetes APIs using [custom resource definitions (CRDs)](https://kubernetes.io/docs/tasks/access-kubernetes-api/extend-api-custom-resource-definitions).
|
10 | 7 |
|
11 | 8 | **Note:** kubebuilder does not exist as an example to *copy-paste*, but instead provides powerful libraries and tools
|
12 | 9 | to simplify building and publishing Kubernetes APIs from scratch.
|
13 | 10 |
|
14 |
| -### Download and Install |
| 11 | +### Installalation |
| 12 | + |
| 13 | +It is strongly recommended that you use a released version. Release binaries are available on the [releases](https://github.com/kubernetes-sigs/kubebuilder/releases) page. |
| 14 | +Follow the [instructions](http://book.kubebuilder.io/getting_started/installation_and_setup.html) to install Kubebuilder. |
15 | 15 |
|
16 |
| -[Releases](https://github.com/kubernetes-sigs/kubebuilder/releases) are here |
17 | 16 |
|
18 | 17 | ## Getting Started
|
19 | 18 |
|
20 | 19 | See the [Getting Started](http://book.kubebuilder.io/quick_start.html) documentation.
|
21 | 20 |
|
22 |
| - |
| 21 | + |
23 | 22 |
|
24 | 23 | ## Documentation
|
25 | 24 |
|
@@ -80,3 +79,8 @@ Before you file an issue, please search existing issues to see if your issue is
|
80 | 79 |
|
81 | 80 | - ### Slack
|
82 | 81 | For realtime discussion, you can join the [#kubebuilder](https://slack.k8s.io/#kubebuilder) slack channel. Slack requires registration, but the Kubernetes team is open invitation to anyone to register here. Feel free to come and ask any questions.
|
| 82 | + |
| 83 | +## Contributing |
| 84 | +Contributions are greatly appreciated. The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers. |
| 85 | +The project follows the typical GitHub pull request model. See [CONTRIBUTING.md](CONTRIBUTING.md) for more details. |
| 86 | +Before starting any work, please either comment on an existing issue, or file a new one. |
0 commit comments