Skip to content

Commit

Permalink
Add godocs for root and package directories
Browse files Browse the repository at this point in the history
  • Loading branch information
pwittrock committed Jun 7, 2018
1 parent 165c6ab commit b7102bc
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 0 deletions.
26 changes: 26 additions & 0 deletions doc.go
Original file line number Diff line number Diff line change
@@ -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
32 changes: 32 additions & 0 deletions pkg/doc.go
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit b7102bc

Please sign in to comment.