From 2c44b22af46da7d4cfb36493517f2364312e8a2d Mon Sep 17 00:00:00 2001
From: Jorge Alarcon Ochoa <alarcj137@gmail.com>
Date: Wed, 15 May 2019 20:26:25 -0400
Subject: [PATCH] Updated doc.go files in staging/src/k8s.io/metrics

Added vanity urls to imports and updated package descriptions.

Signed-off-by: Jorge Alarcon Ochoa <alarcj137@gmail.com>
---
 staging/src/k8s.io/metrics/pkg/apis/custom_metrics/doc.go      | 3 ++-
 .../src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/doc.go  | 3 ++-
 .../src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/doc.go  | 3 ++-
 staging/src/k8s.io/metrics/pkg/apis/external_metrics/doc.go    | 3 ++-
 .../k8s.io/metrics/pkg/apis/external_metrics/v1beta1/doc.go    | 3 ++-
 staging/src/k8s.io/metrics/pkg/apis/metrics/doc.go             | 3 ++-
 staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/doc.go    | 3 ++-
 staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/doc.go     | 3 ++-
 8 files changed, 16 insertions(+), 8 deletions(-)

diff --git a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/doc.go b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/doc.go
index 6810baab230..4ab9acbefc1 100644
--- a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/doc.go
@@ -17,4 +17,5 @@ limitations under the License.
 // +k8s:deepcopy-gen=package
 // +groupName=custom.metrics.k8s.io
 
-package custom_metrics
+// Package custom_metrics defines an API for using custom metrics.
+package custom_metrics // import "k8s.io/metrics/pkg/apis/custom_metrics"
diff --git a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/doc.go b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/doc.go
index a3000047e54..101365b262a 100644
--- a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta1/doc.go
@@ -19,4 +19,5 @@ limitations under the License.
 // +k8s:conversion-gen=k8s.io/metrics/pkg/apis/custom_metrics
 // +k8s:openapi-gen=true
 
-package v1beta1
+// Package v1beta1 is the v1beta1 version of the custom_metrics API.
+package v1beta1 // import "k8s.io/metrics/pkg/apis/custom_metrics/v1beta1"
diff --git a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/doc.go b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/doc.go
index cd9b980264e..30e6e358a58 100644
--- a/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/custom_metrics/v1beta2/doc.go
@@ -19,4 +19,5 @@ limitations under the License.
 // +k8s:conversion-gen=k8s.io/metrics/pkg/apis/custom_metrics
 // +k8s:openapi-gen=true
 
-package v1beta2
+// Package v1beta2 is the v1beta2 version of the custom_metrics API.
+package v1beta2 // import "k8s.io/metrics/pkg/apis/custom_metrics/v1beta2"
diff --git a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/doc.go b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/doc.go
index 5c6ecec9732..edf1553ad24 100644
--- a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/doc.go
@@ -17,4 +17,5 @@ limitations under the License.
 // +k8s:deepcopy-gen=package
 // +groupName=external.metrics.k8s.io
 
-package external_metrics
+// Package external_metrics adds support for defining external metrics.
+package external_metrics // import "k8s.io/metrics/pkg/apis/external_metrics"
diff --git a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/doc.go b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/doc.go
index c44d23e5d8b..aa27d102fc9 100644
--- a/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/external_metrics/v1beta1/doc.go
@@ -19,4 +19,5 @@ limitations under the License.
 // +k8s:conversion-gen=k8s.io/metrics/pkg/apis/external_metrics
 // +k8s:openapi-gen=true
 
-package v1beta1
+// Package v1beta1 is the v1beta1 version of the external metrics API.
+package v1beta1 // import "k8s.io/metrics/pkg/apis/external_metrics/v1beta1"
diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/doc.go b/staging/src/k8s.io/metrics/pkg/apis/metrics/doc.go
index 0f970b0cebc..49e29972687 100644
--- a/staging/src/k8s.io/metrics/pkg/apis/metrics/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/doc.go
@@ -17,4 +17,5 @@ limitations under the License.
 // +k8s:deepcopy-gen=package
 // +groupName=metrics.k8s.io
 
-package metrics
+// Package metrics defines an API for exposing metics.
+package metrics // import "k8s.io/metrics/pkg/apis/metrics"
diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/doc.go b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/doc.go
index 442a81f7a88..8e06b220547 100644
--- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1alpha1/doc.go
@@ -20,4 +20,5 @@ limitations under the License.
 // +k8s:openapi-gen=true
 // +groupName=metrics.k8s.io
 
-package v1alpha1
+// Package v1alpha1 is the v1alpha1 version of the metrics API.
+package v1alpha1 // import "k8s.io/metrics/pkg/apis/metrics/v1alpha1"
diff --git a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/doc.go b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/doc.go
index cdbab832e62..10f5ab9fa5f 100644
--- a/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/doc.go
+++ b/staging/src/k8s.io/metrics/pkg/apis/metrics/v1beta1/doc.go
@@ -20,4 +20,5 @@ limitations under the License.
 // +k8s:openapi-gen=true
 // +groupName=metrics.k8s.io
 
-package v1beta1
+// Package v1beta1 is the v1beta1 version of the metrics API.
+package v1beta1 // import "k8s.io/metrics/pkg/apis/metrics/v1beta1"