summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPrashanth Balasubramanian <beeps@google.com>2016-04-15 19:25:32 -0700
committerPrashanth Balasubramanian <beeps@google.com>2016-04-15 19:25:32 -0700
commit974c57d60ef47ada4083c002070614a04b95ac5f (patch)
tree679b793525debd0216ff82cb6a48228bdc6f0799
parentff66c016355b4bd5ef92161e927426276913f025 (diff)
Clarify api-group docs by a tiny bit.
-rw-r--r--adding-an-APIGroup.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/adding-an-APIGroup.md b/adding-an-APIGroup.md
index 0119c7b9..dec5d3f0 100644
--- a/adding-an-APIGroup.md
+++ b/adding-an-APIGroup.md
@@ -56,7 +56,8 @@ Step 2 and 3 are mechanical, we plan on autogenerate these using the cmd/libs/go
1. Generate conversions and deep-copies:
1. Add your "group/" or "group/version" into hack/after-build/{update-generated-conversions.sh, update-generated-deep-copies.sh, verify-generated-conversions.sh, verify-generated-deep-copies.sh};
- 2. Run hack/update-generated-conversions.sh, hack/update-generated-deep-copies.sh.
+ 2. Make sure your pkg/apis/`<group>`/`<version>` directory has a doc.go file with the comment `// +genconversion=true`, to catch the attention of our gen-conversion script.
+ 3. Run hack/update-all.sh.
2. Generate files for Ugorji codec:
@@ -79,6 +80,7 @@ We are overhauling pkg/client, so this section might be outdated; see [#15730](h
2. Add your "group/version" to `KUBE_API_VERSIONS` and `KUBE_TEST_API_VERSIONS` in hack/test-go.sh.
+TODO: Add a troubleshooting section.