Fix typos in comments and documentation

Co-authored-by: Sebastian Widmer <sebastian.widmer@vshn.net> Co-authored-by: Simon Gerber <simon.gerber@vshn.ch>
projectsyn · Sep 29, 2022 · f858235 · f858235
1 parent 4b306db
commit f858235
Show file tree

Hide file tree

Showing 10 changed files with 23 additions and 23 deletions.
diff --git a/api/v1alpha1/cluster_types.go b/api/v1alpha1/cluster_types.go
@@ -36,7 +36,7 @@ type ClusterSpec struct {
 	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty"`
 	// CreationPolicy defines how the external resources should be treated upon CR creation.
 	// Create: will only create a new external resource and will not manage already existing resources
-	// Adopt:  will create a new external resource or will adopt and manage en already existing resource
+	// Adopt:  will create a new external resource or will adopt and manage an already existing resource
 	// +kubebuilder:validation:Enum=Create;Adopt
 	CreationPolicy CreationPolicy `json:"creationPolicy,omitempty"`
 }
@@ -104,7 +104,7 @@ func (c *Cluster) GetDeletionPolicy() DeletionPolicy {
 	return c.Spec.DeletionPolicy
 }
 
-// GetCreationPolicy returns the object's deletion policy
+// GetCreationPolicy returns the object's creation policy
 func (c *Cluster) GetCreationPolicy() CreationPolicy {
 	return c.Spec.CreationPolicy
 }

diff --git a/api/v1alpha1/gitrepo_types.go b/api/v1alpha1/gitrepo_types.go
@@ -84,7 +84,7 @@ type GitRepoTemplate struct {
 	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty"`
 	// CreationPolicy defines how the external resources should be treated upon CR creation.
 	// Create: will only create a new external resource and will not manage already existing resources
-	// Adopt:  will create a new external resource or will adopt and manage en already existing resource
+	// Adopt:  will create a new external resource or will adopt and manage an already existing resource
 	// +kubebuilder:validation:Enum=Create;Adopt
 	CreationPolicy CreationPolicy `json:"creationPolicy,omitempty"`
 }
@@ -157,7 +157,7 @@ func (g *GitRepo) GetDeletionPolicy() DeletionPolicy {
 	return g.Spec.DeletionPolicy
 }
 
-// GetCreationPolicy returns the object's deletion policy
+// GetCreationPolicy returns the object's creation policy
 func (g *GitRepo) GetCreationPolicy() CreationPolicy {
 	return g.Spec.CreationPolicy
 }

diff --git a/api/v1alpha1/tenant_types.go b/api/v1alpha1/tenant_types.go
@@ -30,7 +30,7 @@ type TenantSpec struct {
 	DeletionPolicy DeletionPolicy `json:"deletionPolicy,omitempty"`
 	// CreationPolicy defines how the external resources should be treated upon CR creation.
 	// Create: will only create a new external resource and will not manage already existing resources
-	// Adopt:  will create a new external resource or will adopt and manage en already existing resource
+	// Adopt:  will create a new external resource or will adopt and manage an already existing resource
 	// +kubebuilder:validation:Enum=Create;Adopt
 	CreationPolicy CreationPolicy `json:"creationPolicy,omitempty"`
 	// ClusterTemplate defines a template which will be used to set defaults for the clusters of this tenant.
@@ -90,7 +90,7 @@ func (t *Tenant) GetDeletionPolicy() DeletionPolicy {
 	return t.Spec.DeletionPolicy
 }
 
-// GetCreationPolicy returns the object's deletion policy
+// GetCreationPolicy returns the object's creation policy
 func (t *Tenant) GetCreationPolicy() CreationPolicy {
 	return t.Spec.CreationPolicy
 }

diff --git a/config/crd/bases/syn.tools_clusters.yaml b/config/crd/bases/syn.tools_clusters.yaml
@@ -50,7 +50,7 @@ spec:
                 description: 'CreationPolicy defines how the external resources should
                   be treated upon CR creation. Create: will only create a new external
                   resource and will not manage already existing resources Adopt:  will
-                  create a new external resource or will adopt and manage en already
+                  create a new external resource or will adopt and manage an already
                   existing resource'
                 enum:
                 - Create
@@ -99,7 +99,7 @@ spec:
                       should be treated upon CR creation. Create: will only create
                       a new external resource and will not manage already existing
                       resources Adopt:  will create a new external resource or will
-                      adopt and manage en already existing resource'
+                      adopt and manage an already existing resource'
                     enum:
                     - Create
                     - Adopt

diff --git a/config/crd/bases/syn.tools_gitrepos.yaml b/config/crd/bases/syn.tools_gitrepos.yaml
@@ -66,7 +66,7 @@ spec:
                 description: 'CreationPolicy defines how the external resources should
                   be treated upon CR creation. Create: will only create a new external
                   resource and will not manage already existing resources Adopt:  will
-                  create a new external resource or will adopt and manage en already
+                  create a new external resource or will adopt and manage an already
                   existing resource'
                 enum:
                 - Create

diff --git a/config/crd/bases/syn.tools_tenants.yaml b/config/crd/bases/syn.tools_tenants.yaml
@@ -54,7 +54,7 @@ spec:
                       should be treated upon CR creation. Create: will only create
                       a new external resource and will not manage already existing
                       resources Adopt:  will create a new external resource or will
-                      adopt and manage en already existing resource'
+                      adopt and manage an already existing resource'
                     enum:
                     - Create
                     - Adopt
@@ -105,7 +105,7 @@ spec:
                           should be treated upon CR creation. Create: will only create
                           a new external resource and will not manage already existing
                           resources Adopt:  will create a new external resource or
-                          will adopt and manage en already existing resource'
+                          will adopt and manage an already existing resource'
                         enum:
                         - Create
                         - Adopt
@@ -198,7 +198,7 @@ spec:
                 description: 'CreationPolicy defines how the external resources should
                   be treated upon CR creation. Create: will only create a new external
                   resource and will not manage already existing resources Adopt:  will
-                  create a new external resource or will adopt and manage en already
+                  create a new external resource or will adopt and manage an already
                   existing resource'
                 enum:
                 - Create
@@ -244,7 +244,7 @@ spec:
                       should be treated upon CR creation. Create: will only create
                       a new external resource and will not manage already existing
                       resources Adopt:  will create a new external resource or will
-                      adopt and manage en already existing resource'
+                      adopt and manage an already existing resource'
                     enum:
                     - Create
                     - Adopt

diff --git a/config/crd/bases/syn.tools_tenanttemplates.yaml b/config/crd/bases/syn.tools_tenanttemplates.yaml
@@ -54,7 +54,7 @@ spec:
                       should be treated upon CR creation. Create: will only create
                       a new external resource and will not manage already existing
                       resources Adopt:  will create a new external resource or will
-                      adopt and manage en already existing resource'
+                      adopt and manage an already existing resource'
                     enum:
                     - Create
                     - Adopt
@@ -105,7 +105,7 @@ spec:
                           should be treated upon CR creation. Create: will only create
                           a new external resource and will not manage already existing
                           resources Adopt:  will create a new external resource or
-                          will adopt and manage en already existing resource'
+                          will adopt and manage an already existing resource'
                         enum:
                         - Create
                         - Adopt
@@ -198,7 +198,7 @@ spec:
                 description: 'CreationPolicy defines how the external resources should
                   be treated upon CR creation. Create: will only create a new external
                   resource and will not manage already existing resources Adopt:  will
-                  create a new external resource or will adopt and manage en already
+                  create a new external resource or will adopt and manage an already
                   existing resource'
                 enum:
                 - Create
@@ -244,7 +244,7 @@ spec:
                       should be treated upon CR creation. Create: will only create
                       a new external resource and will not manage already existing
                       resources Adopt:  will create a new external resource or will
-                      adopt and manage en already existing resource'
+                      adopt and manage an already existing resource'
                     enum:
                     - Create
                     - Adopt

diff --git a/docs/modules/ROOT/pages/explanations/adoption.adoc b/docs/modules/ROOT/pages/explanations/adoption.adoc
@@ -3,7 +3,7 @@
 Repository Adoption is the process of managing Git repositories that weren't created by Lieutenant.
 
 By default if you create a `GitRepo` resource that references a Git repository that already exits, Lieutenant will not adopt and manage it.
-This should prevent accidental modification of exiting repositories and also avoids issues if two `GitRepo` resources reference the same repository.
+This should prevent accidental modification of existing repositories and also avoids issues if two `GitRepo` resources reference the same repository.
 
 Adoption can be enabled per `GitRepo` by setting `spec.creationPolicy` to `Adopt` or as a global default by setting `DEFAULT_CREATION_POLICY` to `Adopt`.
 Enabling adoption can be helpful for migrations or disaster recovery.
diff --git a/docs/modules/ROOT/pages/references/api-reference.adoc b/docs/modules/ROOT/pages/references/api-reference.adoc
@@ -86,7 +86,7 @@ ClusterSpec defines the desired state of Cluster
 | *`tokenLifeTime`* __string__ | TokenLifetime set the token lifetime
 | *`facts`* __object (keys:string, values:string)__ | Facts are key/value pairs for statically configured facts
 | *`deletionPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-deletionpolicy[$$DeletionPolicy$$]__ | DeletionPolicy defines how the external resources should be treated upon CR deletion. Retain: will not delete any external resources Delete: will delete the external resources Archive: will archive the external resources, if it supports that
-| *`creationPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-creationpolicy[$$CreationPolicy$$]__ | CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt:  will create a new external resource or will adopt and manage en already existing resource
+| *`creationPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-creationpolicy[$$CreationPolicy$$]__ | CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt:  will create a new external resource or will adopt and manage an already existing resource
 |===
 
 
@@ -205,7 +205,7 @@ GitRepoTemplate is used for templating git repos, it does not contain the tenant
 | *`displayName`* __string__ | DisplayName of Git repository
 | *`templateFiles`* __object (keys:string, values:string)__ | TemplateFiles is a list of files that should be pushed to the repository after its creation.
 | *`deletionPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-deletionpolicy[$$DeletionPolicy$$]__ | DeletionPolicy defines how the external resources should be treated upon CR deletion. Retain: will not delete any external resources Delete: will delete the external resources Archive: will archive the external resources, if it supports that
-| *`creationPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-creationpolicy[$$CreationPolicy$$]__ | CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt:  will create a new external resource or will adopt and manage en already existing resource
+| *`creationPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-creationpolicy[$$CreationPolicy$$]__ | CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt:  will create a new external resource or will adopt and manage an already existing resource
 |===
 
 
@@ -263,7 +263,7 @@ TenantSpec defines the desired state of Tenant
 | *`globalGitRepoRevision`* __string__ | GlobalGitRepoRevision allows to configure the revision of the global configuration to use. It can be any git tree-ish reference. Defaults to HEAD if left empty.
 | *`gitRepoTemplate`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-gitrepotemplate[$$GitRepoTemplate$$]__ | GitRepoTemplate Template for managing the GitRepo object. If not set, no GitRepo object will be created.
 | *`deletionPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-deletionpolicy[$$DeletionPolicy$$]__ | DeletionPolicy defines how the external resources should be treated upon CR deletion. Retain: will not delete any external resources Delete: will delete the external resources Archive: will archive the external resources, if it supports that
-| *`creationPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-creationpolicy[$$CreationPolicy$$]__ | CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt:  will create a new external resource or will adopt and manage en already existing resource
+| *`creationPolicy`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-creationpolicy[$$CreationPolicy$$]__ | CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt:  will create a new external resource or will adopt and manage an already existing resource
 | *`clusterTemplate`* __xref:{anchor_prefix}-github-com-projectsyn-lieutenant-operator-api-v1alpha1-clusterspec[$$ClusterSpec$$]__ | ClusterTemplate defines a template which will be used to set defaults for the clusters of this tenant. The fields within this can use Go templating. See https://syn.tools/lieutenant-operator/explanations/templating.html for details.
 |===
 

diff --git a/main.go b/main.go
@@ -32,10 +32,10 @@ const (
 	// which specifies the Namespace to watch.
 	// An empty value means the operator is running with cluster scope.
 	watchNamespaceEnvVar = "WATCH_NAMESPACE"
-	// createSAEnvVar is the contant for the env variable which indicates
+	// createSAEnvVar is the constant for the env variable which indicates
 	// whether to create ServiceAccount token secrets
 	createSATokenEnvVar = "LIEUTENANT_CREATE_SERVICEACCOUNT_TOKEN_SECRET"
-	// createSAEnvVar is the contant for the env variable which indicates
+	// createSAEnvVar is the constant for the env variable which indicates
 	// the default creation policy for git repositories
 	defaultCreationPolicy = "DEFAULT_CREATION_POLICY"
 )