From 6d9ebcfae415efa3d4fb4c862ca1351bca239f95 Mon Sep 17 00:00:00 2001 From: Himangini Date: Mon, 1 Aug 2022 15:43:40 +0100 Subject: [PATCH] removed typos from code and updated core maintainer list --- COMMUNITY.md | 2 -- CONTRIBUTING.md | 2 +- examples/04-existing-vpc.yaml | 2 +- examples/10-encrypted-volumes.yaml | 2 +- examples/23-kubeflow-spot-instance.yaml | 2 +- pkg/actions/cluster/delete.go | 2 +- pkg/apis/eksctl.io/register.go | 2 +- pkg/cloudconfig/cloudconfig.go | 6 +++--- pkg/ctl/cmdutils/nodegroup.go | 2 +- userdocs/src/usage/addons.md | 2 +- userdocs/src/usage/eksctl-anywhere.md | 2 +- userdocs/src/usage/faq.md | 2 +- userdocs/src/usage/unowned-clusters.md | 2 +- 13 files changed, 14 insertions(+), 16 deletions(-) diff --git a/COMMUNITY.md b/COMMUNITY.md index 774a289f21..3987c58278 100644 --- a/COMMUNITY.md +++ b/COMMUNITY.md @@ -15,9 +15,7 @@ Ready to start contributing? Head over to our [contribution docs](CONTRIBUTING.m ## Core team The core team of maintainers are Chetan Patwal ([@cPu1](https://github.com/cPu1)), -Jake Klein ([@aclevername](https://github.com/aclevername)), Niki Manoledaki ([@nikimanoledaki](https://github.com/nikimanoledaki)), -Gergely Brautigam ([@Skarlso](https://github.com/Skarlso)), and Himangini Daware ([@Himangini](https://github.com/Himangini)). ## Join us! diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3b17f022b..29a6aac599 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,7 +45,7 @@ Looking forward to seeing you in the repo! :sparkles: # Legal bits ## License -`eksctl` is [Apache 2.0 licenced](LICENSE). +`eksctl` is [Apache 2.0 licensed](LICENSE). ## Certificate of Origin diff --git a/examples/04-existing-vpc.yaml b/examples/04-existing-vpc.yaml index 343707d19d..5fb817bf1f 100644 --- a/examples/04-existing-vpc.yaml +++ b/examples/04-existing-vpc.yaml @@ -11,7 +11,7 @@ vpc: id: "vpc-0dd338ecf29863c55" # (optional, must match VPC ID used for each subnet below) cidr: "192.168.0.0/16" # (optional, must match CIDR used by the given VPC) subnets: - # must provide 'private' and/or 'public' subnets by availibility zone as shown + # must provide 'private' and/or 'public' subnets by availability zone as shown private: eu-north-1a: id: "subnet-0b2512f8c6ae9bf30" diff --git a/examples/10-encrypted-volumes.yaml b/examples/10-encrypted-volumes.yaml index a3cf333c08..2abb123729 100644 --- a/examples/10-encrypted-volumes.yaml +++ b/examples/10-encrypted-volumes.yaml @@ -15,7 +15,7 @@ nodeGroups: volumeType: gp2 volumeEncrypted: true - - name: ng2-encrypt-using-customer-encrytion-key + - name: ng2-encrypt-using-customer-encryption-key instanceType: m5.xlarge desiredCapacity: 1 volumeSize: 100 diff --git a/examples/23-kubeflow-spot-instance.yaml b/examples/23-kubeflow-spot-instance.yaml index 92cd76111d..6923bdf397 100644 --- a/examples/23-kubeflow-spot-instance.yaml +++ b/examples/23-kubeflow-spot-instance.yaml @@ -29,7 +29,7 @@ metadata: # Add all possible AZs to ensure nodes can be spun up in any AZ later on. # THIS CAN'T BE CHANGED LATER. YOU WILL HAVE TO CREATE A NEW CLUSTER TO ADD NEW AZ SUPPORT. -# This list applies to the whole clustr and isn't specific to nodegroups +# This list applies to the whole cluster and isn't specific to nodegroups availabilityZones: ["us-east-1a", "us-east-1b", "us-east-1d", "us-east-1f"] nodeGroups: diff --git a/pkg/actions/cluster/delete.go b/pkg/actions/cluster/delete.go index b274637256..e55fbaa870 100644 --- a/pkg/actions/cluster/delete.go +++ b/pkg/actions/cluster/delete.go @@ -134,7 +134,7 @@ func deleteDeprecatedStacks(ctx context.Context, stackManager manager.StackManag if errs := tasks.DoAllSync(); len(errs) > 0 { return true, handleErrors(errs, "deprecated stacks") } - logger.Success("deleted all %s deperecated stacks", count) + logger.Success("deleted all %s deprecated stacks", count) return true, nil } return false, nil diff --git a/pkg/apis/eksctl.io/register.go b/pkg/apis/eksctl.io/register.go index 3e7f20a295..f9076864b7 100644 --- a/pkg/apis/eksctl.io/register.go +++ b/pkg/apis/eksctl.io/register.go @@ -1,6 +1,6 @@ package api -// Conventional Kubernetes API contants +// Conventional Kubernetes API constants const ( GroupName = "eksctl.io" ) diff --git a/pkg/cloudconfig/cloudconfig.go b/pkg/cloudconfig/cloudconfig.go index 86263e7ed4..857bdb35ef 100644 --- a/pkg/cloudconfig/cloudconfig.go +++ b/pkg/cloudconfig/cloudconfig.go @@ -26,7 +26,7 @@ const ( defaultFilePermissions = "0644" ) -// CloudConfig stores informaiton of the cloud config +// CloudConfig stores information of the cloud config type CloudConfig struct { Commands []interface{} `json:"runcmd"` Packages []string `json:"packages"` @@ -63,7 +63,7 @@ func (c *CloudConfig) AddCommand(cmd ...string) { c.Commands = append(c.Commands, cmd) } -// AddShellCommand adds a shell comannd, which will be run on node start up +// AddShellCommand adds a shell command, which will be run on node start up func (c *CloudConfig) AddShellCommand(cmd string) { c.Commands = append(c.Commands, []string{Shell, "-c", cmd}) } @@ -79,7 +79,7 @@ func (c *CloudConfig) AddFile(f File) { c.WriteFiles = append(c.WriteFiles, f) } -// AddScript adds a scipt, which will be placed on the node +// AddScript adds a script, which will be placed on the node func (c *CloudConfig) AddScript(p, s string) { c.AddFile(File{ Content: s, diff --git a/pkg/ctl/cmdutils/nodegroup.go b/pkg/ctl/cmdutils/nodegroup.go index 907862dc66..9eadb06a0d 100644 --- a/pkg/ctl/cmdutils/nodegroup.go +++ b/pkg/ctl/cmdutils/nodegroup.go @@ -53,7 +53,7 @@ func PopulateNodegroupFromStack(nodeGroupType api.NodeGroupType, nodeGroupName s return nil } -// PopulateUnmanagedNodegroup populates the unmanaged nodegroup field of a ClucterConfig. +// PopulateUnmanagedNodegroup populates the unmanaged nodegroup field of a ClusterConfig. func PopulateUnmanagedNodegroup(nodeGroupName string, cfg *api.ClusterConfig) { cfg.NodeGroups = append(cfg.NodeGroups, &api.NodeGroup{ NodeGroupBase: &api.NodeGroupBase{ diff --git a/userdocs/src/usage/addons.md b/userdocs/src/usage/addons.md index bca5e7de37..b04a79c0f0 100644 --- a/userdocs/src/usage/addons.md +++ b/userdocs/src/usage/addons.md @@ -12,7 +12,7 @@ You can specify what addons you want and what policies (if required) to attach t apiVersion: eksctl.io/v1alpha5 kind: ClusterConfig metadata: - name: exmaple-cluster + name: example-cluster region: us-west-2 version: "1.19" diff --git a/userdocs/src/usage/eksctl-anywhere.md b/userdocs/src/usage/eksctl-anywhere.md index 9c5e199d44..8792817fc1 100755 --- a/userdocs/src/usage/eksctl-anywhere.md +++ b/userdocs/src/usage/eksctl-anywhere.md @@ -1,7 +1,7 @@ # EKS Anywhere `eksctl` provides access to AWS' feature called `EKS Anywhere` with the sub command `eksctl anywhere`. -This requires the `eksctl-anywhere` binary present on `PATH`. Please follow the instruction outlined here [Install eskctl-anywhere](https://anywhere.eks.amazonaws.com/docs/getting-started/install/) +This requires the `eksctl-anywhere` binary present on `PATH`. Please follow the instruction outlined here [Install eksctl-anywhere](https://anywhere.eks.amazonaws.com/docs/getting-started/install/) to install it. Once done, execute anywhere commands by running: diff --git a/userdocs/src/usage/faq.md b/userdocs/src/usage/faq.md index f77e5f2f22..7797d1a837 100644 --- a/userdocs/src/usage/faq.md +++ b/userdocs/src/usage/faq.md @@ -21,7 +21,7 @@ You'll see a name similar to `eksctl-CLUSTER_NAME-nodegroup-NODEGROUP_NAME`. You can execute the following to get the userdata. Note the final line which - decodes from base64 and uncompresses the gzipped data. + decodes from base64 and decompresses the gzipped data. ```bash NG_STACK=eksctl-scrumptious-monster-1595247364-nodegroup-ng-29b8862f # your stack here LAUNCH_TEMPLATE_ID=$(aws cloudformation describe-stack-resources --stack-name $NG_STACK \ diff --git a/userdocs/src/usage/unowned-clusters.md b/userdocs/src/usage/unowned-clusters.md index 345775f200..47c066ad65 100644 --- a/userdocs/src/usage/unowned-clusters.md +++ b/userdocs/src/usage/unowned-clusters.md @@ -63,7 +63,7 @@ for the time-being, `eksctl` will not attempt to retrieve or guess these values. may change in the future as we learn more about how people are using this command on non eksctl-created clusters. This means that in order to create nodegroups or managed nodegroups on a cluster which was -not created by `eksctl`, a config file containing VPC details must be provided. At a minumum: +not created by `eksctl`, a config file containing VPC details must be provided. At a minimum: ```yaml ---