From aa46b6ec44dfbff16b8b925f1db4913fdba04a85 Mon Sep 17 00:00:00 2001 From: Michael Cook Date: Thu, 5 Mar 2020 20:16:00 +0100 Subject: [PATCH] fix misspellings --- README.md | 2 +- api/builtins/NamespaceTransformer.go | 2 +- api/internal/crawl/README.md | 2 +- api/internal/crawl/config/elastic/esbackup.yaml | 2 +- api/internal/crawl/search_cmds/transformer.md | 2 +- docs/FAQ.md | 2 +- docs/eschewedFeatures.md | 2 +- docs/fields.md | 2 +- docs/glossary.md | 4 ++-- docs/plugins/README.md | 2 +- docs/v2.1.0_changelog.md | 2 +- docs/versioningPolicy.md | 2 +- examples/inlinePatch.md | 2 +- plugin/builtin/namespacetransformer/NamespaceTransformer.go | 2 +- 14 files changed, 15 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index 967bf3ad3..aedf5ba6a 100644 --- a/README.md +++ b/README.md @@ -107,7 +107,7 @@ Take the work from step (1) above, move it into a `someApp` subdirectory called `base`, then place overlays in a sibling directory. -An overlay is just another kustomization, refering to +An overlay is just another kustomization, referring to the base, and referring to patches to apply to that base. diff --git a/api/builtins/NamespaceTransformer.go b/api/builtins/NamespaceTransformer.go index d4c701963..1e8804e66 100644 --- a/api/builtins/NamespaceTransformer.go +++ b/api/builtins/NamespaceTransformer.go @@ -52,7 +52,7 @@ func (p *NamespaceTransformerPlugin) Transform(m resmap.ResMap) error { matches := m.GetMatchingResourcesByCurrentId(r.CurId().Equals) if len(matches) != 1 { - return fmt.Errorf("namespace tranformation produces ID conflict: %+v", matches) + return fmt.Errorf("namespace transformation produces ID conflict: %+v", matches) } } return nil diff --git a/api/internal/crawl/README.md b/api/internal/crawl/README.md index 157995eb6..7a9190d92 100644 --- a/api/internal/crawl/README.md +++ b/api/internal/crawl/README.md @@ -209,7 +209,7 @@ but they are functional. ## Technical details -### Overall design and imlpementation +### Overall design and implementations There are a few components that are all running together in order to get the overall application to work smoothly. This section will provide a brief diff --git a/api/internal/crawl/config/elastic/esbackup.yaml b/api/internal/crawl/config/elastic/esbackup.yaml index fbdbee461..378ddc868 100644 --- a/api/internal/crawl/config/elastic/esbackup.yaml +++ b/api/internal/crawl/config/elastic/esbackup.yaml @@ -11,7 +11,7 @@ metadata: spec: storage: gcs: - # the bucket must exist for the snapshot respository to be created successfully. + # the bucket must exist for the snapshot repository to be created successfully. bucket: kustomize-backup # the path does not need to exist. # If the path does not exist, the controller will create the folder in the GCS bucket. diff --git a/api/internal/crawl/search_cmds/transformer.md b/api/internal/crawl/search_cmds/transformer.md index ca4f3ce4c..c358f7e5b 100644 --- a/api/internal/crawl/search_cmds/transformer.md +++ b/api/internal/crawl/search_cmds/transformer.md @@ -1,4 +1,4 @@ -Find all the trasnformer files whose `kinds` field includes `HelmValues`, and +Find all the transformer files whose `kinds` field includes `HelmValues`, and only output certain fields of each document: ``` curl -s -X GET "${ElasticSearchURL}:9200/${INDEXNAME}/_search?pretty" -H 'Content-Type: application/json' -d' diff --git a/docs/FAQ.md b/docs/FAQ.md index b7d01b8e1..25e52cb8e 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -18,7 +18,7 @@ cluster Resources (including configmap and secret generators) can _still be shared_ via the recommended best practice of placing them in a directory with their own -kustomization file, and refering to this directory as a +kustomization file, and referring to this directory as a [`base`](glossary.md#base) from any kustomization that wants to use it. This encourages modularity and relocatability. diff --git a/docs/eschewedFeatures.md b/docs/eschewedFeatures.md index e1a134b73..7ad3ef73f 100644 --- a/docs/eschewedFeatures.md +++ b/docs/eschewedFeatures.md @@ -48,7 +48,7 @@ like adding labels or annotatations, get dedicated transformer plugins - `LabelTransformer`, `AnnotationsTransformer`, etc. These accept relatively simple YAML configuration -allowing easy targetting of any number of resources. +allowing easy targeting of any number of resources. Another class of edits take data from one specific object's field and use it in another (e.g. a service diff --git a/docs/fields.md b/docs/fields.md index 1b2e9d809..10e191ac8 100644 --- a/docs/fields.md +++ b/docs/fields.md @@ -206,7 +206,7 @@ See [field-name-replicas]. ### resources Each entry in this list must be a path to a -_file_, or a path (or URL) refering to another +_file_, or a path (or URL) referring to another kustomization _directory_, e.g. ``` diff --git a/docs/glossary.md b/docs/glossary.md index f29a71a45..b584ff7ff 100644 --- a/docs/glossary.md +++ b/docs/glossary.md @@ -273,9 +273,9 @@ more than one version). _kustomize_ is a command line tool supporting template-free, structured customization of declarative -configuration targetted to k8s-style objects. +configuration targeted to k8s-style objects. -_Targetted to k8s means_ that kustomize has some +_Targeted to k8s means_ that kustomize has some understanding of API resources, k8s concepts like names, labels, namespaces, etc. and the semantics of resource patching. diff --git a/docs/plugins/README.md b/docs/plugins/README.md index 8add73c89..3c1e8c5de 100644 --- a/docs/plugins/README.md +++ b/docs/plugins/README.md @@ -209,7 +209,7 @@ a YAML file containing its configuration (the file name provided in the kustomization file). > TODO: restrictions on plugin to allow the _same exec -> plugin_ to be targetted by both the +> plugin_ to be targeted by both the > `generators` and `transformers` fields. > > - first arg could be the fixed string diff --git a/docs/v2.1.0_changelog.md b/docs/v2.1.0_changelog.md index 82c0564e7..55525d008 100644 --- a/docs/v2.1.0_changelog.md +++ b/docs/v2.1.0_changelog.md @@ -78,7 +78,7 @@ a7a2589e Fix yaml in generator examples. 529db049 Introduce envs field. 6d309b52 Introduce stacked transformers. abf538d8 Keep backward compatibility for image transformer -7e12918f Keep var refernce in resources +7e12918f Keep var references in resources 7130e3ff Leave defautconfig empty for images 3e85c458 Load default config for image transformer 4162dbc2 Maintain resources in order loaded. diff --git a/docs/versioningPolicy.md b/docs/versioningPolicy.md index 859f946bb..8336a4ad0 100644 --- a/docs/versioningPolicy.md +++ b/docs/versioningPolicy.md @@ -37,7 +37,7 @@ the _kustomize Go API_. [import path]: https://github.com/golang/go/wiki/Modules#releasing-modules-v2-or-higher -In `kustomize/v3` (and preceeding major versions), the +In `kustomize/v3` (and preceding major versions), the kustomize program and the API live the same Go module at `sigs.k8s.io/kustomize`, at [import path] `sigs.k8s.io/kustomize/v3`. diff --git a/examples/inlinePatch.md b/examples/inlinePatch.md index 6a32462aa..c3294d5c5 100644 --- a/examples/inlinePatch.md +++ b/examples/inlinePatch.md @@ -4,7 +4,7 @@ # Demo: Inline Patch A kustomization file supports patching in three ways: -- patchesStrategicMerge: A list of patch files where each file is parsed as a [Stragetic Merge Patch]. +- patchesStrategicMerge: A list of patch files where each file is parsed as a [Strategic Merge Patch]. - patchesJSON6902: A list of patches and associated targetes, where each file is parsed as a [JSON Patch] and can only be applied to one target resource. - patches: A list of patches and their associated targets. The patch can be applied to multiple objects. It auto detects whether the patch is a [Strategic Merge Patch] or [JSON Patch]. diff --git a/plugin/builtin/namespacetransformer/NamespaceTransformer.go b/plugin/builtin/namespacetransformer/NamespaceTransformer.go index dd2540a60..3c5720cb3 100644 --- a/plugin/builtin/namespacetransformer/NamespaceTransformer.go +++ b/plugin/builtin/namespacetransformer/NamespaceTransformer.go @@ -56,7 +56,7 @@ func (p *plugin) Transform(m resmap.ResMap) error { matches := m.GetMatchingResourcesByCurrentId(r.CurId().Equals) if len(matches) != 1 { - return fmt.Errorf("namespace tranformation produces ID conflict: %+v", matches) + return fmt.Errorf("namespace transformation produces ID conflict: %+v", matches) } } return nil