diff --git a/README.md b/README.md index acaa5bd..3a36d0e 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ For a full installation process, have a look at the [installation docs](docs/ins Ensure that you have an API token installed in your cluster. Follow our [how to](docs/design/github-connector.md#APIToken) for further instructions. -The GitHub repository resource is used to syncronize releases and pull requests +The GitHub repository resource is used to synchronize releases and pull requests with cluster state, and update pull requests with deployment status. ```yaml @@ -76,7 +76,7 @@ spec: ### Configure an Image Policy -The image policy resource syncronizes Docker container images with cluster +The image policy resource synchronizes Docker container images with cluster state. It cross references with GitHub releases, filtering out images that do not match the versioning policy. @@ -143,5 +143,5 @@ Thanks for taking the time to join the community and helping out! - Please familiarize yourself with the [Code of Conduct](./CODE_OF_CONDUCT.md) before contributing. -- Look at our [Contributing Guidelines](./CONTRIBUTING.md) for more infirmation +- Look at our [Contributing Guidelines](./CONTRIBUTING.md) for more information about setting up your environment and how to contribute. diff --git a/_examples/config-policy.yaml b/_examples/config-policy.yaml index 1d18a23..d08d550 100644 --- a/_examples/config-policy.yaml +++ b/_examples/config-policy.yaml @@ -3,7 +3,7 @@ # Mounts through the ConfigPolicy. # # The ConfigPolicy will be monitored for changes, once changes are detected in -# the configuration or the values of the confniguration (envs), a new deployment +# the configuration or the values of the configuration (envs), a new deployment # for the Microservices which reference this ConfigPolicy will be created. apiVersion: hlnr.io/v1alpha1 kind: ConfigPolicy diff --git a/_examples/hello-hlnr/github-repository.yaml b/_examples/hello-hlnr/github-repository.yaml index b212b47..07100ba 100644 --- a/_examples/hello-hlnr/github-repository.yaml +++ b/_examples/hello-hlnr/github-repository.yaml @@ -1,4 +1,4 @@ -# This secret is your GH API ACCESS token set up with premissions according to [/docs/design/github-connector.md](/docs/design/github-connector.md) +# This secret is your GH API ACCESS token set up with permissions according to [/docs/design/github-connector.md](/docs/design/github-connector.md) apiVersion: v1 kind: Secret metadata: diff --git a/_examples/image-policy-match.yaml b/_examples/image-policy-match.yaml index ae3c40e..61b219c 100644 --- a/_examples/image-policy-match.yaml +++ b/_examples/image-policy-match.yaml @@ -49,7 +49,7 @@ spec: --- -# This configuration uses label matching. You can match on any number of lables, +# This configuration uses label matching. You can match on any number of labels, # with or without name. If a given label does not exist on a container image, # it will not match. # diff --git a/docs/design/github-connector.md b/docs/design/github-connector.md index cebd732..1f770f0 100644 --- a/docs/design/github-connector.md +++ b/docs/design/github-connector.md @@ -6,7 +6,7 @@ have been opened. To do this, there is a CRD installed which allows you to specify a repository and credentials to connect to this repository. The connector will configure the -appropiate webhooks with this repository to get callback information based on +appropriate webhooks with this repository to get callback information based on Release and PullRequest events. The connector also takes care of setting up a callback server, allowing GitHub diff --git a/docs/design/image-policy.md b/docs/design/image-policy.md index 2d86df5..8742914 100644 --- a/docs/design/image-policy.md +++ b/docs/design/image-policy.md @@ -8,7 +8,7 @@ from. The ImagePolicy is then responsible for validating that the desired images are available in the linked registry. ImagePolicies can optionally define a match configuration. Match is used to -control how GitHub releases map to container registry images. By defaut, the +control how GitHub releases map to container registry images. By default, the release name is directly mapped to an image tag name. You can use `from` and `to` values to do pattern matching on the GitHub release, and templating to match container image tags. You can also define container image labels to match diff --git a/docs/design/versioning-policy.md b/docs/design/versioning-policy.md index e485f97..c8da02b 100644 --- a/docs/design/versioning-policy.md +++ b/docs/design/versioning-policy.md @@ -17,7 +17,7 @@ form of `v1.2.3`. Release Candidates are used for staging environments. These should be in the form off `v1.2.3-rc.0`. This indicates that we can also have multiple release -candiates for the same release. +candidates for the same release. ## Preview diff --git a/internal/configpolicy/controller.go b/internal/configpolicy/controller.go index 2413dda..b146ea0 100644 --- a/internal/configpolicy/controller.go +++ b/internal/configpolicy/controller.go @@ -21,7 +21,7 @@ import ( ) // Controller represents the MicroserviceController. This controller -// takes care of creating, updating and deleting lower level Kubernetese +// takes care of creating, updating and deleting lower level Kubernetes // components that are associated with a specific Microservice. type Controller struct { rc *rest.RESTClient diff --git a/internal/networkpolicy/controller.go b/internal/networkpolicy/controller.go index ec287a7..ac9417a 100644 --- a/internal/networkpolicy/controller.go +++ b/internal/networkpolicy/controller.go @@ -23,7 +23,7 @@ import ( ) // Controller represents the MicroserviceController. This controller -// takes care of creating, updating and deleting lower level Kubernetese +// takes care of creating, updating and deleting lower level Kubernetes // components that are associated with a specific Microservice. type Controller struct { rc *rest.RESTClient diff --git a/internal/svc/controller.go b/internal/svc/controller.go index 484f8a8..b2edee9 100644 --- a/internal/svc/controller.go +++ b/internal/svc/controller.go @@ -29,7 +29,7 @@ type patchClient interface { } // Controller represents the MicroserviceController. This controller -// takes care of creating, updating and deleting lower level Kubernetese +// takes care of creating, updating and deleting lower level Kubernetes // components that are associated with a specific Microservice. type Controller struct { rc *rest.RESTClient diff --git a/internal/vsvc/controller.go b/internal/vsvc/controller.go index 0a979d9..799d19b 100644 --- a/internal/vsvc/controller.go +++ b/internal/vsvc/controller.go @@ -21,7 +21,7 @@ import ( ) // Controller represents the VersionedMicroserviceController. This controller -// takes care of creating, updating and deleting lower level Kubernetese +// takes care of creating, updating and deleting lower level Kubernetes // components that are associated with a specific VersionedMicroservice. type Controller struct { rc *rest.RESTClient diff --git a/internal/vsvc/disruption.go b/internal/vsvc/disruption.go index bdaeaaf..7e2bc10 100644 --- a/internal/vsvc/disruption.go +++ b/internal/vsvc/disruption.go @@ -15,7 +15,7 @@ import ( var ( // ErrMinMaxAvailabilitySet is used when the Availability Configuration has - // both MinAvailabe and MaxUnavailable set. + // both MinAvailable and MaxUnavailable set. ErrMinMaxAvailabilitySet = errors.New("Can't have both MinAvailable and MaxUnavailable configured") )