-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #162 from pwittrock/docs-gen
Add section on boilerplate to the docs.
- Loading branch information
Showing
3 changed files
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
{% panel style="info", title="Under Development" %} | ||
This book is being actively developed. | ||
{% endpanel %} | ||
|
||
# Defining Boilerplate License Headers | ||
|
||
{% method %} | ||
|
||
It is possible to add boilerplate license headers to all generated code by | ||
modifying `hack/boilerplate.go.txt`. | ||
|
||
If you don't create `boilerplate.go.txt` an empty version will be created for you by | ||
`kubebuilder init`. Modifying this file will only impact files created afterward. | ||
|
||
{% sample lang="bash" %} | ||
|
||
```bash | ||
mkdir hack | ||
echo "// MY LICENSE" > hack/boilerplate.go.txt | ||
kubebuilder init --domain k8s.io | ||
``` | ||
|
||
{% endmethod %} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters