Move quick start guide from README.md into the GitBook. #146
Conversation
k8s-ci-robot
added
size/XL
README.md
Outdated
| @@ -10,11 +10,9 @@ the release program.* To build your own release see [CONTRIBUTING.md](CONTRIBUT | |||
|
|
|||
| [Release](https://github.com/kubernetes-sigs/kubebuilder/releases): | |||
|
|
|||
| - [latest](https://github.com/kubernetes-sigs/kubebuilder/releases/latest) | |||
|
|
|||
| ## Book | |||
There was a problem hiding this comment.
I would suggest adding Getting Started heading just before the book heading because "book" heading might be perceived as some long form of reading which might discourage some impatient users :)
docs/book/go_docs.md
Outdated
| @@ -0,0 +1,24 @@ | |||
| ## GoDoc | |||
|
|
|||
There was a problem hiding this comment.
I feel the content in this file is more like notes to users. Maybe we can create a more organized structure.
There was a problem hiding this comment.
Changed this just to be links to the GoDoc
docs/book/go_docs.md
Outdated
| - [config libraries](https://godoc.org/github.com/kubernetes-sigs/kubebuilder/pkg/config) | ||
| - [signals libraries](https://godoc.org/github.com/kubernetes-sigs/kubebuilder/pkg/signals) | ||
|
|
||
| Kubebuilder generates codes for custom resource fields, and controller components such as watchers and informers. You have to add code generation tags in form of comment directives to initiate the code generation: |
There was a problem hiding this comment.
These code generation tags are so important. I missed one of the informer tag in the core type controller template. It caused a failure and I spent a few hours debugging it. I'd like to see we put the docs for the tags in a more obvious place. Something like Important note in the controller documentation.
There was a problem hiding this comment.
There is a section on this in the Controller section. Added a warning note as well.
pwittrock
force-pushed
the
docs-gen
branch
4 times, most recently
from
62a532e to
08bbd1a
Compare
No description provided.