Skip to content

Commit 9a93468

Browse files
committed
Clean up README
1 parent d0dc250 commit 9a93468

File tree

1 file changed

+15
-19
lines changed

1 file changed

+15
-19
lines changed

README.md

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
*Don't use `go get` / `go install`, instead you MUST download a tar binary release or create your own release using
55
the release program.* To build your own release see [CONTRIBUTING.md](CONTRIBUTING.md)
66

7-
## Releases
8-
97
## `kubebuilder`
108

119
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).
@@ -15,27 +13,25 @@ to simplify building and publishing Kubernetes APIs from scratch.
1513

1614
### Download and Install
1715

18-
[Releases](https://github.com/kubernetes-sigs/kubebuilder/releases):
16+
[Releases](https://github.com/kubernetes-sigs/kubebuilder/releases) are here
1917

2018
## Getting Started
2119

2220
See the [Getting Started](http://book.kubebuilder.io/quick_start.html) documentation.
2321

24-
## Documentation
25-
26-
[book.kubebuilder.io](http://book.kubebuilder.io)
22+
![Quick Start](docs/gif/quickstart.gif)
2723

28-
#### Quick Start Demo
24+
## Documentation
2925

30-
![Quick Start](docs/gif/quickstart.gif)
26+
Check out the Kubebuilder [book](http://book.kubebuilder.io).
3127

3228
## Resources
3329

34-
GitBook: [book.kubebuilder.com](http://book.kubebuilder.com)
35-
GitHub Repo: [kubernetes-sigs/kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
36-
Slack channel: [#kubeuilder](http://slack.k8s.io/#kubebuilder)
37-
Google Group: [[email protected]](https://groups.google.com/forum/#!forum/kubebuilder)
38-
Planned Work: [Sprint Dashboard](https://github.com/kubernetes-sigs/kubebuilder/projects/1)
30+
- GitBook: [book.kubebuilder.com](http://book.kubebuilder.io)
31+
- GitHub Repo: [kubernetes-sigs/kubebuilder](https://github.com/kubernetes-sigs/kubebuilder)
32+
- Slack channel: [#kubebuilder](http://slack.k8s.io/#kubebuilder)
33+
- Google Group: [[email protected]](https://groups.google.com/forum/#!forum/kubebuilder)
34+
- Planned Work: [Sprint Dashboard](https://github.com/kubernetes-sigs/kubebuilder/projects/1)
3935

4036
## Motivation
4137

@@ -53,11 +49,11 @@ Kubebuilder attempts to facilitate the following developer workflow for building
5349
5. Update bootstrapped integration tests to test new fields and business logic
5450
6. Build and publish a container from the provided Dockerfile
5551

56-
### Scope
52+
## Scope
5753

5854
Building APIs using CRDs, Controllers and Admission Webhooks.
5955

60-
### Philosophy
56+
## Philosophy
6157

6258
Provide clean library abstractions with clear and well exampled godocs.
6359

@@ -66,7 +62,7 @@ Provide clean library abstractions with clear and well exampled godocs.
6662
- Prefer *1 time init* of stubs over forked and modified boilerplate
6763
- Never fork and modify boilerplate
6864

69-
### Techniques
65+
## Techniques
7066

7167
- Provide higher level libraries on top of low level client libraries
7268
- Protect developers from breaking changes in low level libraries
@@ -76,11 +72,11 @@ Provide clean library abstractions with clear and well exampled godocs.
7672
- Driven off of `//+` comments
7773
- Provide bootstrapping commands to initialize new packages
7874

79-
### Troubleshooting
75+
## Troubleshooting
8076

81-
- #### Bugs and Feature Requests:
77+
- ### Bugs and Feature Requests:
8278
If you have what looks like a bug, or you would like to make a feature request, please use the [Github issue tracking system.](https://github.com/kubernetes-sigs/kubebuilder/issues)
8379
Before you file an issue, please search existing issues to see if your issue is already covered.
8480

85-
- #### Slack
81+
- ### Slack
8682
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.

0 commit comments

Comments
 (0)