Skip to content

Commit b2722c7

Browse files
author
Phillip Wittrock
authored
Merge pull request #193 from pwittrock/docs-gen
Update GitBook docs with warning about core-type scaffold tests failing
2 parents ea97177 + 75b766a commit b2722c7

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

docs/book/beyond_basics/controllers_for_core_resources.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,25 @@ This book is being actively developed.
44

55
## Controllers for Core Resources
66

7+
{% panel style="warning", title="Core Only Projects" %}
8+
If your project will *only* contain controllers for types defined outside your project,
9+
you must create the project with the `--controller-only` flag.
10+
{% endpanel %}
11+
712
{% method %}
813

9-
It it possible to create Controllers for Core resources, or for resources defined outside your project.
14+
It is possible to create Controllers for Core resources, or for resources defined outside your project.
1015

1116
{% sample lang="bash" %}
1217
```bash
1318
kubebuilder create controller --group apps --version v1beta2 --kind Deployment --core-type
1419
```
1520
{% endmethod %}
1621

17-
{% panel style="warning", title="Core Only Projects" %}
18-
If your project will *only* contain controllers for types defined outside your project,
19-
you must create the project with the `--controller-only` flag.
22+
{% panel style="warning", title="Scaffold Tests May Not Pass" %}
23+
When creating controllers for core and existing types, it may be necessary to modify
24+
the scaffold tests before they pass.
25+
26+
This is because the empty objet may not be valid and have required fields not
27+
set in the scaffold test.
2028
{% endpanel %}

0 commit comments

Comments
 (0)