Correct spelling mistakes #2645

jsoref · 2022-05-04T04:09:35Z

Proposed changes

Describe the use case and detail of the change. If this PR addresses an issue on GitHub, make sure to include a link to that issue here in this description (not in the title of the PR).

This PR corrects misspellings identified by the check-spelling action.

The misspellings have been reported at jsoref@5503c5e#commitcomment-72824593

The action reports that the changes in this PR would make it happy: jsoref@1af0f5c

Note: this PR does not include the action. If you're interested in running a spell check on every PR and push, that can be offered separately.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works -- tests are not expected to be merged with this PR, but they're available...
I have checked that all unit tests pass after adding my changes
I have updated necessary documentation
I have rebased my branch onto main
I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Signed-off-by: Josh Soref <[email protected]>

jsoref

Most corrections were automatically suggested by Google Sheets.
All fault is mine.

jsoref · 2022-05-04T04:10:03Z

CHANGELOG.md

-An automatically generated list of changes can be found on Github at: [2.2.0 Release](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v2.2.0)
+An automatically generated list of changes can be found on GitHub at: [2.2.0 Release](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v2.2.0)


Brand.

Some projects don't like changing changelogs. I can drop files if requested.

jsoref · 2022-05-04T04:11:11Z

docs/content/configuration/policy-resource.md

-|``dryRun`` | Enables the dry run mode. In this mode, the rate limit is not actually applied, but the the number of excessive requests is accounted as usual in the shared memory zone. | ``bool`` | No |
+|``dryRun`` | Enables the dry run mode. In this mode, the rate limit is not actually applied, but the number of excessive requests is accounted as usual in the shared memory zone. | ``bool`` | No |


Doubled words are a new area for me. I'm still not terribly confident about them.

I understand that things like this probably will require a chart release. I'll cross that bridge at the end.

jsoref · 2022-05-04T04:11:20Z

examples/custom-resources/egress-mtls/README.md

-## Step 2 - Deploy the Egress MLTS Secret
+## Step 2 - Deploy the Egress MTLS Secret


jsoref · 2022-05-04T04:11:27Z

examples/custom-resources/grpc-upstreams/README.md

-    secret: gprc-secret
+    secret: grpc-secret


jsoref · 2022-05-04T04:12:39Z

internal/configs/ingress_test.go

-	mergeableIngresses.Minions[0].Ingress.Annotations["nginx.com/jwt-login-url"] = "https://login.cofee.example.com"
+	mergeableIngresses.Minions[0].Ingress.Annotations["nginx.com/jwt-login-url"] = "https://login.coffee.example.com"


I'm assuming there aren't any hashes that care about this change.

jsoref · 2022-05-04T04:12:49Z

internal/configs/oidc/oidc.conf

-    #     allow 127.0.0.1; # Only the NGINX host may call the NIGNX Plus API
+    #     allow 127.0.0.1; # Only the NGINX host may call the NGINX Plus API


jsoref · 2022-05-04T04:16:20Z

tests/data/ingress-mtls/policies/ingress-mtls-invalid.yaml

-  ingredsssMTLS: # invalid/mis-spelled yaml keys
-    clientCertSecrettt: ingress-mtls-secret
+  ingress_MTLS: # invalid/mis-spelled yaml keys
+    clientCertSecret_: ingress-mtls-secret


I understand you're trying to misspell things, but there are ways to generate invalid content that doesn't result in spell checkers screaming. As you can see, there are plenty of misspelled items, some of which are user facing. I argue it's better to avoid misspelling words when possible, and using a _ should work for that purpose. (If not _, then adding another word or swapping the order of words or substituting a word...)

lucacome

@jsoref the changes in the strings in the tests are making them fail

lucacome · 2022-05-05T17:36:36Z

deployments/common/crds/appprotectdos.f5.com_dosprotectedresources.yaml

@@ -31,7 +31,7 @@ spec:
            metadata:
              type: object
            spec:
-              description: DosProtectedResourceSpec deines the properties and values a DosProtectedResource can have.
+              description: DosProtectedResourceSpec defines the properties and values a DosProtectedResource can have.


the CRD are automatically generated, so we need to change the source

pinging @rafwegv

lucacome · 2022-05-05T17:53:49Z

internal/configs/virtualserver_test.go

@@ -4927,7 +4927,7 @@ func TestGenerateSSLConfig(t *testing.T) {
 				RejectHandshake: true,
 			},
 			expectedWarnings: Warnings{
-				nil: []string{"TLS secret secret is invalid: secret doesn't exist"},
+				nil: []string{"TLS secret is invalid: secret doesn't exist"},


Changing this (and the following one) will make the test fail. The second secret here is just the name specified on line 4916.

The templated thing should wrap the evaluated thing with backticks to make it easier for a human to parse

Signed-off-by: Josh Soref <[email protected]>

codecov-commenter · 2022-05-08T10:54:32Z

Codecov Report

Merging #2645 (9961427) into main (22d3d7f) will increase coverage by 0.02%.
The diff coverage is 28.57%.

@@            Coverage Diff             @@
##             main    #2645      +/-   ##
==========================================
+ Coverage   53.39%   53.42%   +0.02%     
==========================================
  Files          52       52              
  Lines       14706    14706              
==========================================
+ Hits         7853     7857       +4     
+ Misses       6591     6589       -2     
+ Partials      262      260       -2

Impacted Files	Coverage Δ
internal/configs/annotations.go	`21.56% <0.00%> (ø)`
internal/k8s/controller.go	`10.87% <0.00%> (ø)`
internal/k8s/utils.go	`11.76% <ø> (ø)`
internal/metrics/collectors/latency.go	`49.66% <ø> (ø)`
internal/metrics/collectors/processes.go	`0.00% <0.00%> (ø)`
internal/nginx/fake_manager.go	`0.00% <ø> (ø)`
internal/configs/virtualserver.go	`95.32% <100.00%> (ø)`
internal/k8s/configuration.go	`95.86% <0.00%> (+0.38%)`	⬆️

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

jsoref added 24 commits May 3, 2022 22:54

spelling: annotations

018d226

Signed-off-by: Josh Soref <[email protected]>

spelling: certificate

dd49ab0

Signed-off-by: Josh Soref <[email protected]>

spelling: coffee

71834e3

Signed-off-by: Josh Soref <[email protected]>

spelling: configurable

6db850d

Signed-off-by: Josh Soref <[email protected]>

spelling: configurations

f895301

Signed-off-by: Josh Soref <[email protected]>

spelling: defines

8a0152c

Signed-off-by: Josh Soref <[email protected]>

spelling: endpoints

c8e2667

Signed-off-by: Josh Soref <[email protected]>

spelling: factory

4c186ba

Signed-off-by: Josh Soref <[email protected]>

spelling: github

8a165c6

Signed-off-by: Josh Soref <[email protected]>

spelling: grpc

bab915f

Signed-off-by: Josh Soref <[email protected]>

spelling: implementation

90139f0

Signed-off-by: Josh Soref <[email protected]>

spelling: ingress

1c921d2

Signed-off-by: Josh Soref <[email protected]>

spelling: internal

cfaa0a5

Signed-off-by: Josh Soref <[email protected]>

spelling: invalid

e4064fc

Signed-off-by: Josh Soref <[email protected]>

spelling: kubernetes

b322df5

Signed-off-by: Josh Soref <[email protected]>

spelling: manager

489ce36

Signed-off-by: Josh Soref <[email protected]>

spelling: mtls

880851d

Signed-off-by: Josh Soref <[email protected]>

spelling: multipart

39695a7

Signed-off-by: Josh Soref <[email protected]>

spelling: namespace

6ca4522

Signed-off-by: Josh Soref <[email protected]>

spelling: nginx

b370fed

Signed-off-by: Josh Soref <[email protected]>

spelling: override

03acf0f

Signed-off-by: Josh Soref <[email protected]>

spelling: passthrough

29da1be

Signed-off-by: Josh Soref <[email protected]>

spelling: processes

d01147a

Signed-off-by: Josh Soref <[email protected]>

spelling: resource

8205a84

Signed-off-by: Josh Soref <[email protected]>

jsoref commented May 4, 2022

View reviewed changes

lucacome requested changes May 5, 2022

View reviewed changes

jsoref added 4 commits May 8, 2022 06:03

spelling: secret

480ca47

Signed-off-by: Josh Soref <[email protected]>

spelling: signing

92bfc84

Signed-off-by: Josh Soref <[email protected]>

spelling: the

80694f2

Signed-off-by: Josh Soref <[email protected]>

spelling: validate

41cd30c

Signed-off-by: Josh Soref <[email protected]>

jsoref added 2 commits May 8, 2022 06:03

spelling: wildcard

72b30df

Signed-off-by: Josh Soref <[email protected]>

spelling: with

38514c9

Signed-off-by: Josh Soref <[email protected]>

jsoref force-pushed the spelling branch from 9e29f3e to 38514c9 Compare May 8, 2022 10:04

Merge branch 'main' into spelling

9961427

lucacome approved these changes May 9, 2022

View reviewed changes

lucacome requested review from a team, ciarams87, jjngx and shaun-nx May 9, 2022 12:04

ciarams87 approved these changes May 9, 2022

View reviewed changes

lucacome added the documentation Pull requests/issues for documentation label May 10, 2022

lucacome changed the title ~~Spelling~~ Correct spelling mistakes May 10, 2022

lucacome merged commit 028a449 into nginx:main May 10, 2022

jsoref deleted the spelling branch May 10, 2022 23:29

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Correct spelling mistakes #2645

Correct spelling mistakes #2645

jsoref commented May 4, 2022

jsoref left a comment

jsoref May 4, 2022

jsoref May 4, 2022

jsoref May 4, 2022

jsoref May 4, 2022

jsoref May 4, 2022

jsoref May 4, 2022

jsoref May 4, 2022

lucacome left a comment

lucacome May 5, 2022

lucacome May 5, 2022

jsoref May 5, 2022

codecov-commenter commented May 8, 2022 •

edited

Loading

		An automatically generated list of changes can be found on Github at: [2.2.0 Release](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v2.2.0)
		An automatically generated list of changes can be found on GitHub at: [2.2.0 Release](https://github.com/nginxinc/kubernetes-ingress/releases/tag/v2.2.0)

		\|``dryRun`` \| Enables the dry run mode. In this mode, the rate limit is not actually applied, but the the number of excessive requests is accounted as usual in the shared memory zone. \| ``bool`` \| No \|
		\|``dryRun`` \| Enables the dry run mode. In this mode, the rate limit is not actually applied, but the number of excessive requests is accounted as usual in the shared memory zone. \| ``bool`` \| No \|

		## Step 2 - Deploy the Egress MLTS Secret
		## Step 2 - Deploy the Egress MTLS Secret

		mergeableIngresses.Minions[0].Ingress.Annotations["nginx.com/jwt-login-url"] = "https://login.cofee.example.com"
		mergeableIngresses.Minions[0].Ingress.Annotations["nginx.com/jwt-login-url"] = "https://login.coffee.example.com"

		# allow 127.0.0.1; # Only the NGINX host may call the NIGNX Plus API
		# allow 127.0.0.1; # Only the NGINX host may call the NGINX Plus API

Correct spelling mistakes #2645

Correct spelling mistakes #2645

Conversation

jsoref commented May 4, 2022

Proposed changes

Checklist

jsoref left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lucacome left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov-commenter commented May 8, 2022 • edited Loading

Codecov Report

codecov-commenter commented May 8, 2022 •

edited

Loading