From 8f17374a0dfc3036d34de623b813502224326b47 Mon Sep 17 00:00:00 2001 From: Mark Mandel Date: Mon, 27 Nov 2017 16:50:19 -0800 Subject: [PATCH] Code Generator: Link back to examples and articles Link to the sample-controller and external blog post that have the current best path to learning how to use this library. --- staging/src/k8s.io/code-generator/README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/staging/src/k8s.io/code-generator/README.md b/staging/src/k8s.io/code-generator/README.md index 504a4c3f002..5808c86b354 100644 --- 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.