Merge pull request #56452 from markmandel/patch-1

Automatic merge from submit-queue. If you want to cherry-pick this change to another branch, please follow the instructions <a href="https://github.com/kubernetes/community/blob/master/contributors/devel/cherry-picks.md">here</a>. Code Generator: Link back to examples and articles **What this PR does / why we need it**: Link to the sample-controller and external blog post that have the current best path to learning how to use this library. Right now this is not as documented as it could be, and this links to current best documentation. Context: [Friction Log](https://docs.google.com/document/d/1N1pBov7Odpg_u-kILHcswYh4VO-aMlYQdFIH64DYeek/edit#)

Merge pull request #56452 from markmandel/patch-1
710a1240 · Kubernetes Submit Queue · GitHub · d3b677dd · 8f17374a · 710a1240
Unverified Commit 710a1240 authored Nov 28, 2017 by Kubernetes Submit Queue Committed by GitHub Nov 28, 2017
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 0 deletions

README.md staging/src/k8s.io/code-generator/README.md +4 -0

No files found.
--- a/staging/src/k8s.io/code-generator/README.md
+++ b/staging/src/k8s.io/code-generator/README.md
@@ -10,6 +10,10 @@ These code-generators can be used
 - in the context of [User-provider API Servers](https://github.com/kubernetes/apiserver) to build conversions between internal and versioned types, defaulters, protobuf codecs,
  internal and versioned clients and informers.
+## Resources
+- The example [sample controller](https://github.com/kubernetes/sample-controller) shows a code example of a controller that uses the clients, listers and informers generated by this library.
+- The article [Kubernetes Deep Dive: Code Generation for CustomResources](https://blog.openshift.com/kubernetes-deep-dive-code-generation-customresources/) gives a step by step instruction on how to use this library.
 ## Compatibility
 HEAD of this repo will match HEAD of k8s.io/apiserver, k8s.io/apimachinery, and k8s.io/client-go.