Add package godoc from CONTRIBUTING.md (#109)

This PR is for issue #104

Add the package descriptions from [CONTRIBUTING.md](https://github.com/open-telemetry/opentelemetry-operator/blob/master/CONTRIBUTING.md) to the per-package godoc.

Some packages do not contain any Go files, so they are not modified in this PR.

Author: IanvsPoplicola

CONTRIBUTING.md

@@ -71,44 +71,7 @@ Tests can also be run without an existing cluster. For that, install [`kubebuild
 
 ## Project Structure
 
-Here's a general overview of the directories from this operator and what to expect in each one of them:
-
-```
-.
-├── api               # the CRDs that are handled by this operator
-│   └── v1alpha1      # the (currently) only CRD version we have
-├── build             # where the binaries are placed after `make manager`
-├── config            # the Kustomize resources that are used to assemble the operator's deployment units
-│   ├── certmanager   # Kustomize options dealing with cert-manager
-│   ├── crd           # Kustomize options for our CRDs
-│   │   ├── bases     # auto generated based on the code annotations (`make manifests`)
-│   │   └── patches   # patches to apply to the generated CRD
-│   ├── default       # Kustomize's "entry point", generating the distribution YAML file
-│   ├── manager       # the operator's Deployment
-│   ├── manifests     # the resulting CSV
-│   │   └── bases
-│   ├── prometheus    # ServiceMonitor that exposes our operator's metrics
-│   ├── rbac          # RBAC rules
-│   ├── samples       # Set of examples of how to accomplish specific scenarios. Those are bundled in the final CSV
-│   └── webhook       # Webhook configuration and service
-├── controllers       # our main controller, where the reconciliation starts
-├── hack              # utility scripts
-├── internal          # code shared with our internal packages
-│   ├── config        # our operator's runtime configuration
-│   ├── podinjector   # the webhook that injects sidecars into pods
-│   └── version       # our version, as well as versions of underlying components
-├── local             # local resources that shouldn't be added to the version control, like CRs used for dev/testing
-└── pkg               # packages that are exporter and are part of the public API for this module
-    ├── autodetect    # auto detect traits from the environment (platform, APIs, ...)
-    ├── collector     # code that handles OpenTelemetry Collector
-    │   ├── adapters  # data conversion
-    │   ├── parser    # parses the OpenTelemetry Collector configuration
-    │   ├── reconcile # reconciliation logic for OpenTelemetry Collector components
-    │   └── upgrade   # handles the upgrade routine from one OpenTelemetry Collector to the next
-    ├── naming        # determines the names for components (containers, services, ...)
-    ├── platform      # target platforms this operator might run
-    └── sidecar       # operations related to sidecar manipulation (add, update, remove)
-```
+For a general overview of the directories from this operator and what to expect in each one of them, please check out the [official GoDoc](https://godoc.org/github.com/open-telemetry/opentelemetry-operator) or the [locally-hosted GoDoc](http://localhost:6060/pkg/github.com/open-telemetry/opentelemetry-operator/)
 
 ## Contributing
 

api/v1alpha1/groupversion_info.go

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group
+// Package v1alpha1 contains API Schema definitions for the core v1alpha1 API group.
 // +kubebuilder:object:generate=true
 // +groupName=opentelemetry.io
 package v1alpha1

config/README.md

@@ -0,0 +1,19 @@
+## Structure
+
+The `config` folder contains the Kustomize resources that are used to assemble the operator's deployment units
+
+```
+.
+├── certmanager   # Kustomize options dealing with cert-manager
+├── crd           # Kustomize options for our CRDs
+│   ├── bases     # auto generated based on the code annotations (`make manifests`)
+│   └── patches   # patches to apply to the generated CRD
+├── default       # Kustomize's "entry point", generating the distribution YAML file
+├── manager       # the operator's Deployment
+├── manifests     # the resulting CSV
+│   └── bases
+├── prometheus    # ServiceMonitor that exposes our operator's metrics
+├── rbac          # RBAC rules
+├── samples       # Set of examples of how to accomplish specific scenarios. Those are bundled in the final CSV
+└── webhook       # Webhook configuration and service
+```

controllers/opentelemetrycollector_controller.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package controllers contains the main controller, where the reconciliation starts.
 package controllers
 
 import (

internal/config/main.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package config contains the operator's runtime configuration.
 package config
 
 import (

internal/podinjector/main.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package podinjector contains the webhook that injects sidecars into pods.
 package podinjector
 
 import (

internal/version/main.go

@@ -1,3 +1,4 @@
+// Package version contains the operator's version, as well as versions of underlying components.
 package version
 
 import (

pkg/autodetect/main.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package autodetect is for auto-detecting traits from the environment (platform, APIs, ...).
 package autodetect
 
 import (

pkg/collector/adapters/config_from.go

@@ -1,3 +1,4 @@
+// Package adapters is for data conversion.
 package adapters
 
 import (

pkg/collector/parser/receiver.go

@@ -1,3 +1,4 @@
+// Package parser is for parsing the OpenTelemetry Collector configuration.
 package parser
 
 import (

pkg/collector/reconcile/opentelemetry.go

@@ -1,3 +1,4 @@
+// Package reconcile contains reconciliation logic for OpenTelemetry Collector components.
 package reconcile
 
 import (

pkg/collector/upgrade/upgrade.go

@@ -1,3 +1,4 @@
+// Package upgrade handles the upgrade routine from one OpenTelemetry Collector to the next.
 package upgrade
 
 import (

pkg/collector/volume.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package collector handles the OpenTelemetry Collector.
 package collector
 
 import (

pkg/naming/main.go

@@ -1,3 +1,4 @@
+// Package naming is for determining the names for components (containers, services, ...).
 package naming
 
 import (

pkg/platform/main.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package platform contains target platforms this operator might run on.
 package platform
 
 // Platform holds the auto-detected platform type

pkg/sidecar/pod.go

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package sidecar contains operations related to sidecar manipulation (add, update, remove).
 package sidecar
 
 import (