- Minor changes to documentations

- Code format fixes - Redundant parentheses removed Signed-off-by: Shailesh Pant <[email protected]>
vmware-tanzu · Feb 16, 2022 · 53c077e · 53c077e
1 parent 1fab38a
commit 53c077e
Show file tree

Hide file tree

Showing 9 changed files with 24 additions and 24 deletions.
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -39,7 +39,7 @@ The list of current maintainers can be found in
 While anyone can review a PR and is encouraged to do so, only maintainers are
 allowed to merge the PR. To maintain velocity, two approvals (either maintainers or reviewers) are
 required to merge a given PR. In case of a disagreement between maintainers, a
-vote should be called (on Github or Slack) and a simple majority is required in
+vote should be called (on GitHub or Slack) and a simple majority is required in
 order for the PR to be merged.
 
 New maintainers must be nominated from contributors by an existing maintainer

diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -2,11 +2,11 @@
 
 ## Maintainers
 
-| Maintainer | GitHub ID | Affiliation |
-|------------|-----------|-------------|
-|Anusha Hegde | [anusha94](https://github.com/anusha94 ) | [VMware](https://www.github.com/vmware/) |
-|Dharmjit Singh | [dharmjit](https://github.com/dharmjit/ ) | [VMware](https://www.github.com/vmware/) |
-|Jamie Monserrate | [jamiemonserrate](https://github.com/jamiemonserrate ) | [VMware](https://www.github.com/vmware/) |
+| Maintainer       | GitHub ID                                              | Affiliation                              |
+|------------------|--------------------------------------------------------|------------------------------------------|
+| Anusha Hegde     | [anusha94](https://github.com/anusha94 )               | [VMware](https://www.github.com/vmware/) |
+| Dharmjit Singh   | [dharmjit](https://github.com/dharmjit/ )              | [VMware](https://www.github.com/vmware/) |
+| Jamie Monserrate | [jamiemonserrate](https://github.com/jamiemonserrate ) | [VMware](https://www.github.com/vmware/) |
 
 ## Core Contributors and Stakeholders
 

diff --git a/Makefile b/Makefile
@@ -80,7 +80,7 @@ webhook-test:
 # More info on the usage of ANSI control characters for terminal formatting:
 # https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters
 # More info on the awk command:
-# http://linuxcommand.org/lc3_adv_awk.php
+# https://linuxcommand.org/lc3_adv_awk.php
 
 help: ## Display this help.
 	@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n  make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf "  \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

diff --git a/agent/installer/bundle_downloader_test.go b/agent/installer/bundle_downloader_test.go
@@ -92,14 +92,14 @@ var _ = Describe("Byohost Installer Tests", func() {
 				k8sVersion,
 				testTag,
 				mi.Get)
-			Expect(err).ShouldNot((HaveOccurred()))
+			Expect(err).ShouldNot(HaveOccurred())
 			_, err = os.Stat(bd.GetBundleDirPath(k8sVersion, testTag))
-			Expect(err).ShouldNot((HaveOccurred()))
+			Expect(err).ShouldNot(HaveOccurred())
 			notExist := os.IsNotExist(err)
 			Expect(notExist).ShouldNot(BeTrue())
 
 			_, err = os.Stat(bd.GetBundleDirPath(k8sVersion+"a", testTag))
-			Expect(err).Should((HaveOccurred()))
+			Expect(err).Should(HaveOccurred())
 			notExist = os.IsNotExist(err)
 			Expect(notExist).Should(BeTrue())
 		})

diff --git a/agent/installer/installer_test.go b/agent/installer/installer_test.go
@@ -17,13 +17,13 @@ var _ = Describe("Byohost Installer Tests", func() {
 	Context("When installer is created for unsupported OS", func() {
 		It("Should return error", func() {
 			_, err := newUnchecked("Ubuntu_99.04.3_x86-64", "", logr.Discard(), nil)
-			Expect(err).Should((HaveOccurred()))
+			Expect(err).Should(HaveOccurred())
 		})
 	})
 	Context("When installer is created with empty download path", func() {
 		It("Should return error", func() {
 			_, err := New("", logr.Discard())
-			Expect(err).Should((HaveOccurred()))
+			Expect(err).Should(HaveOccurred())
 		})
 	})
 	Context("When installer is created", func() {
@@ -33,10 +33,10 @@ var _ = Describe("Byohost Installer Tests", func() {
 				i := NewPreviewInstaller(os, nil)
 
 				err := i.Install("", "unsupported-k8s", testTag)
-				Expect(err).Should((HaveOccurred()))
+				Expect(err).Should(HaveOccurred())
 
 				err = i.Uninstall("", "unsupported-k8s", testTag)
-				Expect(err).Should((HaveOccurred()))
+				Expect(err).Should(HaveOccurred())
 			}
 		})
 	})
@@ -49,15 +49,15 @@ var _ = Describe("Byohost Installer Tests", func() {
 						ob := algo.OutputBuilderCounter{}
 						i := NewPreviewInstaller(os, &ob)
 						err := i.Install("", k8s, testTag)
-						Expect(err).ShouldNot((HaveOccurred()))
+						Expect(err).ShouldNot(HaveOccurred())
 						Expect(ob.LogCalledCnt).Should(Equal(22))
 					}
 
 					{
 						ob := algo.OutputBuilderCounter{}
 						i := NewPreviewInstaller(os, &ob)
 						err := i.Uninstall("", k8s, testTag)
-						Expect(err).ShouldNot((HaveOccurred()))
+						Expect(err).ShouldNot(HaveOccurred())
 						Expect(ob.LogCalledCnt).Should(Equal(22))
 					}
 				}

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -25,7 +25,7 @@ Kubernetes cluster will be transformed into a [management cluster](https://clust
 
 2. **Kind**
 
-If you are testing locally, you can use [Kind][kind] create a cluster with the following command:
+If you are testing locally, you can use [Kind][kind] to create a cluster with the following command:
 
 ```shell
 kind create cluster

diff --git a/test/e2e/e2e_debug_helper.go b/test/e2e/e2e_debug_helper.go
@@ -144,4 +144,4 @@ func ShowInfo(allAgentLogFiles []string) {
 	WriteShellScript(ReadByohControllerManagerLogShellFile, shellContent)
 	ShowFileContent(ReadByohControllerManagerLogShellFile)
 	ExecuteShellScript(ReadByohControllerManagerLogShellFile)
-}
+}
diff --git a/test/e2e/e2e_docker_helper.go b/test/e2e/e2e_docker_helper.go
@@ -220,12 +220,12 @@ func setControlPlaneIP(ctx context.Context, dockerClient *client.Client) {
 	}
 	inspect, _ := dockerClient.NetworkInspect(ctx, "kind", types.NetworkInspectOptions{})
 	ipOctets := strings.Split(inspect.IPAM.Config[0].Subnet, ".")
-	
-	// The ControlPlaneEndpoint is a static IP that is in the hosts' 
-	// subnet but outside of its DHCP range. We believe 151 is a pretty 
-	// high number and we have < 10 containers being spun up, so we 
+
+	// The ControlPlaneEndpoint is a static IP that is in the hosts'
+	// subnet but outside of its DHCP range. We believe 151 is a pretty
+	// high number and we have < 10 containers being spun up, so we
 	// can safely use this IP for the ControlPlaneEndpoint
 	ipOctets[3] = "151"
 	ip := strings.Join(ipOctets, ".")
 	os.Setenv("CONTROL_PLANE_ENDPOINT_IP", ip)
-}
+}
diff --git a/test/e2e/md_scale_test.go b/test/e2e/md_scale_test.go
@@ -84,7 +84,7 @@ var _ = Describe("When testing MachineDeployment scale out/in", func() {
 		// TODO: Write agent logs to files for better debugging
 
 		By("creating a workload cluster with one control plane node and one worker node")
-		
+
 		setControlPlaneIP(context.Background(), dockerClient)
 		clusterctl.ApplyClusterTemplateAndWait(ctx, clusterctl.ApplyClusterTemplateAndWaitInput{
 			ClusterProxy: bootstrapClusterProxy,