Skip to content

Commit ec97131

Browse files
author
redismongo
authored
chore: fix some comments (operator-framework#6717)
Signed-off-by: redismongo <[email protected]>
1 parent 3969b9b commit ec97131

File tree

12 files changed

+18
-18
lines changed

12 files changed

+18
-18
lines changed

changelog/generated/v1.33.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@
1313

1414
### Bug Fixes
1515

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))

hack/generate/samples/internal/go/generate.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ func GenerateMemcachedSamples(binaryPath, rootPath string) {
2424

2525
// TODO: replace the Memcached implementation and update the tutorial
2626
// to use the deploy.image/v1-alpha plugin to do the scaffold instead
27-
// to create an empty scaffold add add all code. So that, we can also
27+
// to create an empty scaffold add all code. So that, we can also
2828
// ensure that the tutorial follows the good practices
2929
withcustomization.GenerateSample(binaryPath, filepath.Join(rootPath, "go", "v4"))
3030
withcustomization.GenerateSample(binaryPath, filepath.Join(rootPath, "go", "v4", "monitoring"))

hack/generate/samples/internal/go/memcached-with-customization/e2e_test_code.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -242,7 +242,7 @@ var _ = Describe("memcached", Ordered, func() {
242242
_, err = utils.Run(cmd)
243243
ExpectWithOffset(1, err).NotTo(HaveOccurred())
244244
245-
By("loading the the manager(Operator) image on Kind")
245+
By("loading the manager(Operator) image on Kind")
246246
err = utils.LoadImageToKindClusterWithName(operatorImage)
247247
ExpectWithOffset(1, err).NotTo(HaveOccurred())
248248
@@ -455,7 +455,7 @@ var _ = Describe("memcached", Ordered, func() {
455455
_, err = utils.Run(cmd)
456456
ExpectWithOffset(1, err).NotTo(HaveOccurred())
457457
458-
By("loading the the manager(Operator) image on Kind")
458+
By("loading the manager(Operator) image on Kind")
459459
err = utils.LoadImageToKindClusterWithName(operatorImage)
460460
ExpectWithOffset(1, err).NotTo(HaveOccurred())
461461

internal/helm/controller/reconcile.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ func (r HelmOperatorReconciler) Reconcile(ctx context.Context, request reconcile
109109
reconcileResult := reconcile.Result{RequeueAfter: r.ReconcilePeriod}
110110
// Determine the correct reconcile period based on the existing value in the reconciler and the
111111
// annotations in the custom resource. If a reconcile period is specified in the custom resource
112-
// annotations, this value will take precedence over the the existing reconcile period value
112+
// annotations, this value will take precedence over the existing reconcile period value
113113
// (which came from either the command-line flag or the watches.yaml file).
114114
finalReconcilePeriod, err := determineReconcilePeriod(r.ReconcilePeriod, o)
115115
if err != nil {

internal/helm/flags/flag.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ type Flags struct {
4747
flagSet *pflag.FlagSet
4848
}
4949

50-
// AddTo - Add the helm operator flags to the the flagset
50+
// AddTo - Add the helm operator flags to the flagset
5151
func (f *Flags) AddTo(flagSet *pflag.FlagSet) {
5252
// Store flagset internally to be used for lookups later.
5353
f.flagSet = flagSet

testdata/go/v4/memcached-operator/test/e2e/e2e_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ var _ = Describe("memcached", Ordered, func() {
102102
_, err = utils.Run(cmd)
103103
ExpectWithOffset(1, err).NotTo(HaveOccurred())
104104

105-
By("loading the the manager(Operator) image on Kind")
105+
By("loading the manager(Operator) image on Kind")
106106
err = utils.LoadImageToKindClusterWithName(operatorImage)
107107
ExpectWithOffset(1, err).NotTo(HaveOccurred())
108108

testdata/go/v4/monitoring/memcached-operator/test/e2e/e2e_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ var _ = Describe("memcached", Ordered, func() {
118118
_, err = utils.Run(cmd)
119119
ExpectWithOffset(1, err).NotTo(HaveOccurred())
120120

121-
By("loading the the manager(Operator) image on Kind")
121+
By("loading the manager(Operator) image on Kind")
122122
err = utils.LoadImageToKindClusterWithName(operatorImage)
123123
ExpectWithOffset(1, err).NotTo(HaveOccurred())
124124

website/content/en/docs/building-operators/golang/tutorial.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ controllers/memcached_controller.go
8989

9090
This will scaffold the Memcached resource API at `api/v1alpha1/memcached_types.go` and the controller at `controllers/memcached_controller.go`.
9191

92-
**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"`
92+
**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"`
9393

9494
**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.
9595

website/content/en/docs/faqs/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ linkTitle: FAQ
44
weight: 12
55
---
66

7-
## What are the the differences between Kubebuilder and Operator-SDK?
7+
## What are the differences between Kubebuilder and Operator-SDK?
88

99
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].
1010

website/content/en/docs/testing-operators/scorecard/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ See an example of the JSON format produced by a scorecard test:
228228

229229
### XML format
230230

231-
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.
231+
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.
232232

233233
```xml
234234
<testsuites name="scorecard">

website/content/en/docs/upgrading-sdk-version/v1.0.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -339,7 +339,7 @@ _See [#3484](https://github.com/operator-framework/operator-sdk/pull/3484) for m
339339
340340
### Removed package `pkg/ready`
341341
342-
Use `controller-runtime`'s readyz server that supports custom http handlers. Add add a `healthz.Checker` (e.g. [`healthz.Ping`](
342+
Use `controller-runtime`'s readyz server that supports custom http handlers. Add a `healthz.Checker` (e.g. [`healthz.Ping`](
343343
https://github.com/kubernetes-sigs/controller-runtime/blob/229c3c357d9e6b07c3d6774010c35161a82b08f9/pkg/healthz/healthz.go#L187-L188))
344344
using [`manager.AddReadyzCheck`](https://github.com/kubernetes-sigs/controller-runtime/blob/229c3c357d9e6b07c3d6774010c35161a82b08f9/pkg/manager/manager.go#L73-L74).
345345

website/content/en/docs/upgrading-sdk-version/version-upgrade-guide.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ Upon updating the project to `v0.8.2` the following breaking changes apply:
353353
354354
**modules**
355355
356-
- Ensure the the following `replace` directives are present in your `go.mod` file:
356+
- Ensure the following `replace` directives are present in your `go.mod` file:
357357
```
358358
replace (
359359
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:
414414

415415
**modules**
416416

417-
- Ensure the the following `replace` directives are present in your `go.mod` file:
417+
- Ensure the following `replace` directives are present in your `go.mod` file:
418418
```
419419
// Pinned to kubernetes-1.14.1
420420
replace (
@@ -506,7 +506,7 @@ Using `dep` is no longer supported. Follow [Go's official blog post about migrat
506506

507507
**modules**
508508

509-
- Ensure the the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
509+
- Ensure the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
510510

511511
```
512512
require (
@@ -574,7 +574,7 @@ func printVersion() {
574574

575575
**modules**
576576

577-
- Ensure the the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
577+
- Ensure the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
578578

579579
```
580580
require (
@@ -641,7 +641,7 @@ For further detailed information see [CHANGELOG](https://github.com/operator-fra
641641
642642
**modules**
643643
644-
- Ensure the the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
644+
- Ensure the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
645645
646646
```
647647
require (
@@ -868,7 +868,7 @@ If you are using any external helm v2 tooling with the your helm operator-manage
868868

869869
**modules**
870870

871-
- Ensure the the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
871+
- Ensure the following `require` modules and `replace` directives with the specific versions are present in your `go.mod` file:
872872

873873
```
874874
require (

0 commit comments

Comments
 (0)