chore: fix some comments (#6717)

redismongo · web-flow · commit ec9713150817 · 2024-04-11T08:27:00.000-05:00
Signed-off-by: redismongo &lt;yuanchaowei@outlook.com&gt;
diff --git a/changelog/generated/v1.33.0.md b/changelog/generated/v1.33.0.md
@@ -13,4 +13,4 @@
 
 ### Bug Fixes
 
-- `operator-sdk olm install`: fix a bug where the retry logic would not retry until the the command's timeout was reached, resulting in early exiting of the command before the specified timeout was reached. ([#6613](https://github.com/operator-framework/operator-sdk/pull/6613))
+- `operator-sdk olm install`: fix a bug where the retry logic would not retry until the command's timeout was reached, resulting in early exiting of the command before the specified timeout was reached. ([#6613](https://github.com/operator-framework/operator-sdk/pull/6613))
diff --git a/hack/generate/samples/internal/go/generate.go b/hack/generate/samples/internal/go/generate.go
@@ -24,7 +24,7 @@ func GenerateMemcachedSamples(binaryPath, rootPath string) {
 
 	// TODO: replace the Memcached implementation and update the tutorial
 	// to use the deploy.image/v1-alpha plugin to do the scaffold instead
-	// to create an empty scaffold add add all code. So that, we can also
+	// to create an empty scaffold add all code. So that, we can also
 	// ensure that the tutorial follows the good practices
 	withcustomization.GenerateSample(binaryPath, filepath.Join(rootPath, "go", "v4"))
 	withcustomization.GenerateSample(binaryPath, filepath.Join(rootPath, "go", "v4", "monitoring"))
diff --git a/hack/generate/samples/internal/go/memcached-with-customization/e2e_test_code.go b/hack/generate/samples/internal/go/memcached-with-customization/e2e_test_code.go
@@ -242,7 +242,7 @@ var _ = Describe("memcached", Ordered, func() {
 			_, err = utils.Run(cmd)
 			ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-			By("loading the the manager(Operator) image on Kind")
+			By("loading the manager(Operator) image on Kind")
 			err = utils.LoadImageToKindClusterWithName(operatorImage)
 			ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
@@ -455,7 +455,7 @@ var _ = Describe("memcached", Ordered, func() {
 			_, err = utils.Run(cmd)
 			ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-			By("loading the the manager(Operator) image on Kind")
+			By("loading the manager(Operator) image on Kind")
 			err = utils.LoadImageToKindClusterWithName(operatorImage)
 			ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
diff --git a/internal/helm/controller/reconcile.go b/internal/helm/controller/reconcile.go
@@ -109,7 +109,7 @@ func (r HelmOperatorReconciler) Reconcile(ctx context.Context, request reconcile
 	reconcileResult := reconcile.Result{RequeueAfter: r.ReconcilePeriod}
 	// Determine the correct reconcile period based on the existing value in the reconciler and the
 	// annotations in the custom resource. If a reconcile period is specified in the custom resource
-	// annotations, this value will take precedence over the the existing reconcile period value
+	// annotations, this value will take precedence over the existing reconcile period value
 	// (which came from either the command-line flag or the watches.yaml file).
 	finalReconcilePeriod, err := determineReconcilePeriod(r.ReconcilePeriod, o)
 	if err != nil {
diff --git a/internal/helm/flags/flag.go b/internal/helm/flags/flag.go
@@ -47,7 +47,7 @@ type Flags struct {
 	flagSet *pflag.FlagSet
 }
 
-// AddTo - Add the helm operator flags to the the flagset
+// AddTo - Add the helm operator flags to the flagset
 func (f *Flags) AddTo(flagSet *pflag.FlagSet) {
 	// Store flagset internally to be used for lookups later.
 	f.flagSet = flagSet
diff --git a/testdata/go/v4/memcached-operator/test/e2e/e2e_test.go b/testdata/go/v4/memcached-operator/test/e2e/e2e_test.go
@@ -102,7 +102,7 @@ var _ = Describe("memcached", Ordered, func() {
 			_, err = utils.Run(cmd)
 			ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-			By("loading the the manager(Operator) image on Kind")
+			By("loading the manager(Operator) image on Kind")
 			err = utils.LoadImageToKindClusterWithName(operatorImage)
 			ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
diff --git a/testdata/go/v4/monitoring/memcached-operator/test/e2e/e2e_test.go b/testdata/go/v4/monitoring/memcached-operator/test/e2e/e2e_test.go
@@ -118,7 +118,7 @@ var _ = Describe("memcached", Ordered, func() {
 			_, err = utils.Run(cmd)
 			ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
-			By("loading the the manager(Operator) image on Kind")
+			By("loading the manager(Operator) image on Kind")
 			err = utils.LoadImageToKindClusterWithName(operatorImage)
 			ExpectWithOffset(1, err).NotTo(HaveOccurred())
 
diff --git a/website/content/en/docs/building-operators/golang/tutorial.md b/website/content/en/docs/building-operators/golang/tutorial.md
@@ -89,7 +89,7 @@ controllers/memcached_controller.go
 
 This will scaffold the Memcached resource API at `api/v1alpha1/memcached_types.go` and the controller at `controllers/memcached_controller.go`.
 
-**Note:** In this tutorial we will be providing all the steps to show you how to implement an operator project. However, as a follow up you might want to check the [Deploy Image plugin][deploy-image-plugin-doc] with which it is possible to have the whole code generated to deploy and manage an Operand(image). To do so, you can use the the command `$ operator-sdk create api --group cache --version v1alpha1 --kind Memcached --plugins="deploy-image/v1-alpha" --image=memcached:1.4.36-alpine --image-container-command="memcached,-m=64,modern,-v" --run-as-user="1001"`
+**Note:** In this tutorial we will be providing all the steps to show you how to implement an operator project. However, as a follow up you might want to check the [Deploy Image plugin][deploy-image-plugin-doc] with which it is possible to have the whole code generated to deploy and manage an Operand(image). To do so, you can use the command `$ operator-sdk create api --group cache --version v1alpha1 --kind Memcached --plugins="deploy-image/v1-alpha" --image=memcached:1.4.36-alpine --image-container-command="memcached,-m=64,modern,-v" --run-as-user="1001"`
 
 **Note:** This guide will cover the default case of a single group API. If you would like to support Multi-Group APIs see the [Single Group to Multi-Group][multigroup-kubebuilder-doc] doc.
 
diff --git a/website/content/en/docs/faqs/_index.md b/website/content/en/docs/faqs/_index.md
@@ -4,7 +4,7 @@ linkTitle: FAQ
 weight: 12
 ---
 
-## What are the the differences between Kubebuilder and Operator-SDK?
+## What are the differences between Kubebuilder and Operator-SDK?
 
 Kubebuilder and Operator SDK are both projects that allow you to quickly create and manage an operator project. Operator SDK uses Kubebuilder under the hood to do so for Go projects, such that the `operator-sdk` CLI tool will work with a project created by `kubebuilder`. Therefore each project makes use of [controller-runtime][controller-runtime] and will have the same [basic layout][kb-doc-what-is-a-basic-project]. For further information also check the [SDK Project Layout][project-doc].
 
diff --git a/website/content/en/docs/testing-operators/scorecard/_index.md b/website/content/en/docs/testing-operators/scorecard/_index.md
@@ -228,7 +228,7 @@ See an example of the JSON format produced by a scorecard test:
 
 ### XML format
 
-See the example below for the results of a scorecard test formatted in XML. The scorecard tool formats the XML output for XUnit schema compatability. This format makes it easier for post-processing the test results.
+See the example below for the results of a scorecard test formatted in XML. The scorecard tool formats the XML output for XUnit schema compatibility. This format makes it easier for post-processing the test results.
 
 ```xml
 <testsuites name="scorecard">
diff --git a/website/content/en/docs/upgrading-sdk-version/v1.0.0.md b/website/content/en/docs/upgrading-sdk-version/v1.0.0.md
@@ -339,7 +339,7 @@ _See [#3484](https://github.com/operator-framework/operator-sdk/pull/3484) for m
 
 ### Removed package `pkg/ready`
 
-Use `controller-runtime`'s readyz server that supports custom http handlers. Add add a `healthz.Checker` (e.g. [`healthz.Ping`](
+Use `controller-runtime`'s readyz server that supports custom http handlers. Add a `healthz.Checker` (e.g. [`healthz.Ping`](
 https://github.com/kubernetes-sigs/controller-runtime/blob/229c3c357d9e6b07c3d6774010c35161a82b08f9/pkg/healthz/healthz.go#L187-L188))
 using [`manager.AddReadyzCheck`](https://github.com/kubernetes-sigs/controller-runtime/blob/229c3c357d9e6b07c3d6774010c35161a82b08f9/pkg/manager/manager.go#L73-L74).
 
diff --git a/website/content/en/docs/upgrading-sdk-version/version-upgrade-guide.md b/website/content/en/docs/upgrading-sdk-version/version-upgrade-guide.md
@@ -353,7 +353,7 @@ Upon updating the project to `v0.8.2` the following breaking changes apply:
 
 **modules**
 
-- Ensure the the following `replace` directives are present in your `go.mod` file:
+- Ensure the following `replace` directives are present in your `go.mod` file:
     ```
     replace (
             github.com/coreos/prometheus-operator => github.com/coreos/prometheus-operator v0.29.0
@@ -414,7 +414,7 @@ Upon updating the project to `v0.8.2` the following breaking changes apply:
 
 **modules**
 
-- Ensure the the following `replace` directives are present in your `go.mod` file:
+- Ensure the following `replace` directives are present in your `go.mod` file:
     ```
     // Pinned to kubernetes-1.14.1
     replace (
@@ -506,7 +506,7 @@ Using `dep` is no longer supported. Follow [Go's official blog post about migrat
 
 **modules**
 
-- Ensure the the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
+- Ensure the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
 
 ```
 require (
@@ -574,7 +574,7 @@ func printVersion() {
 
 **modules**
 
-- Ensure the the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
+- Ensure the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
 
 ```
 require (
@@ -641,7 +641,7 @@ For further detailed information see [CHANGELOG](https://github.com/operator-fra
 
 **modules**
 
-- Ensure the the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
+- Ensure the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
 
 ```
 require (
@@ -868,7 +868,7 @@ If you are using any external helm v2 tooling with the your helm operator-manage
 
 **modules**
 
-- Ensure the the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
+- Ensure the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
 
 ```
 require (

Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,4 @@`
`13`	`13`
`14`	`14`	`### Bug Fixes`
`15`	`15`
`16`		-- `operator-sdk olm install`: fix a bug where the retry logic would not retry until the the command's timeout was reached, resulting in early exiting of the command before the specified timeout was reached. ([#6613](https://github.com/operator-framework/operator-sdk/pull/6613))
	`16`	+- `operator-sdk olm install`: fix a bug where the retry logic would not retry until the command's timeout was reached, resulting in early exiting of the command before the specified timeout was reached. ([#6613](https://github.com/operator-framework/operator-sdk/pull/6613))
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ type Flags struct {`
`47`	`47`	`flagSet *pflag.FlagSet`
`48`	`48`	`}`
`49`	`49`
`50`		`-// AddTo - Add the helm operator flags to the the flagset`
	`50`	`+// AddTo - Add the helm operator flags to the flagset`
`51`	`51`	`func (f Flags) AddTo(flagSet pflag.FlagSet) {`
`52`	`52`	`// Store flagset internally to be used for lookups later.`
`53`	`53`	`f.flagSet = flagSet`