From b7102bcb9869105014843c80a63c03adc46abca3 Mon Sep 17 00:00:00 2001
From: Phillip Wittrock <pwittroc@google.com>
Date: Thu, 7 Jun 2018 12:35:12 -0700
Subject: [PATCH] Add godocs for root and package directories

---
 doc.go     | 26 ++++++++++++++++++++++++++
 pkg/doc.go | 32 ++++++++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 doc.go
 create mode 100644 pkg/doc.go

diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000000..7a55ea7eec
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,26 @@
+/*
+Copyright 2017 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// The controller_runtime package is a directory containing other packages
+//
+// Example
+//
+// The example package contains examples of using the controller-runtime libraries.
+//
+// Pkg
+//
+// The pkg package contains the libraries.
+package controller_runtime
diff --git a/pkg/doc.go b/pkg/doc.go
new file mode 100644
index 0000000000..1b09f041e5
--- /dev/null
+++ b/pkg/doc.go
@@ -0,0 +1,32 @@
+/*
+Copyright 2017 The Kubernetes Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+// The pkg package is a directory containing other packages
+//
+// Controller
+//
+// The controller package contains libraries for implementing Kubernetes APIs as Controllers by watching
+// resources in a Kubernetes apiserver.
+//
+// Client
+//
+// The client package contains libraries for performing CRUD operations against a Kubernetes apiserver.
+// Typically a client should be create by a ControllerManager from the controller package.
+//
+// Runtime
+//
+// The runtime package contains convenience utilities for logging and signal handling.
+package pkg