[CHORE] Spelling #3062

jsoref · 2024-10-31T17:37:04Z

Change description

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

This is going to be more of a guide of work as opposed to what's merged.

The misspellings have been reported at https://github.com/jsoref/k8s-config-connector/actions/runs/11616624707#summary-32350007792

The action reports that the changes in this PR would make it relatively happy: https://github.com/jsoref/k8s-config-connector/actions/runs/11616625321#summary-32350008984 (the unrecognized words are fine, I just didn't update the list again, there's a doubled alongside, but that's from another repository so, I'll have to send them a PR separately).

I've tried to be careful about only updating generated items that were changed by things that resulted in CI being happy (my default is to exclude all /generated/ items, but there were some that CI cared about, and some where the masters aren't in this repository, so it was a bit of a balance).

Tests you have done

I created a PR to test CI, check-spelling-sandbox#1 there were a couple (~5) of failures, but they also appeared to be present in master.

Run make ready-pr to ensure this PR is ready for review.
Perform necessary E2E testing for changed resources.

google-oss-prow · 2024-10-31T17:37:17Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign maqiuyujoyce for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

jsoref · 2024-10-31T17:37:14Z

CONTRIBUTING.md

@@ -2,7 +2,7 @@

 We'd love to accept your patches and contributions to this project. We use this
 GitHub project as our primary source of truth and the main development
-repository for Config Connetor. The source code in this project is also
+repository for Config Connector. The source code in this project is also


jsoref · 2024-10-31T17:38:04Z

CONTRIBUTING.md

@@ -114,7 +114,7 @@ repo to quickly set up a local dev environment.
    ./docker-setup.sh
    ```

-1.  Exit your current session, then SSH back in to the VM. Then run the
+1.  Exit your current session, then SSH back into the VM. Then run the


into changes tend to be controversial. I'm happy to drop any changes and am certainly not attached to these. From my perspective you're "going into the VM" which is why I think it's correct.

CONTRIBUTING.md

jsoref · 2024-10-31T17:40:06Z

CONTRIBUTING.md

@@ -367,14 +367,14 @@ can run it locally on your dev machine with the steps below.
 If you are adding a new resource, you need to follow the steps in [NewResourceFromTerraform.md](README.ChangingTerraform.md)
 to make code changes, add test data, and run the tests for your resource.

-If you are working on a existing resource, test yaml should exist under
+If you are working on an existing resource, test yaml should exist under


check-spelling ignores 1 and 2 letter words -- changes in this file were by hand because I read the file...

jsoref · 2024-10-31T17:40:57Z

CONTRIBUTING.md

-   # Export the environment variables needed in the dynamic tests if you haven't done it.
-   TEST_FOLDER_ID=123456789 go test -v -tags=integration ./pkg/controller/dynamic/ -test.run TestCreateNoChangeUpdateDelete -run-tests cloudschedulerjob -timeout 900s
- ```
+# Export the environment variables needed in the dynamic tests if you haven't done it.
+TEST_FOLDER_ID=123456789 go test -v -tags=integration ./pkg/controller/dynamic/ -test.run TestCreateNoChangeUpdateDelete -run-tests cloudschedulerjob -timeout 900s
+```


The indentation here didn't match the rest of the file...

jsoref · 2024-10-31T18:43:06Z

...positions/composition/tests/data/TestSimplePlanStatusErrorFailedApplyingManifests/input.yaml

@@ -133,7 +133,7 @@ spec:
    name: common
    template: |
      apiVersion: v1
-      kind: MonfigCap ## should fail
+      kind: ConfigCap_ ## should fail


I tend to favor using _s to trigger failures as opposed to having random typos. They're equivalent from a "does not match" and "could be a typo" perspective, but using typos makes it easier for other more problematic typos to be present in a project (see the rest of this PR).

pkg/dcl/kcclite/conversion.go

jsoref · 2024-10-31T19:06:29Z

pkg/servicemapping/servicemappingloader/servicemappingloader.go

@@ -251,7 +251,7 @@ func fileToServiceMapping(key string) (*v1alpha1.ServiceMapping, error) {
 func parseServiceMapping(b []byte) (*v1alpha1.ServiceMapping, error) {
 	var sm v1alpha1.ServiceMapping
 	if err := yaml.UnmarshalStrict(b, &sm); err != nil {
-		return nil, fmt.Errorf("error unmarshaling byte to service mapping: %w", err)
+		return nil, fmt.Errorf("error unmarshalling byte to service mapping: %w", err)


I normally don't harmonize these two spellings, but the proposed spelling is fairly dominant in this repository.

jsoref · 2024-10-31T19:10:21Z

pkg/webhook/immutable_fields_validator_test.go

@@ -2161,7 +2161,7 @@ var TestCases = []TestCase{
 		},
 		ExpectedResult: []string{"ipAddress"},
 	},
-	// (TODO:maqiuyu): Add a test case for resourceID once supported.
+	// TODO(maqiuyu): Add a test case for resourceID once supported.


this is for consistency

jsoref · 2024-10-31T19:11:23Z

scripts/generate-google3-docs/resource-reference/templates/dataform_dataformrepository.tmpl

@@ -27,7 +27,7 @@
 </tr>
 <tr>
 <td>{{"{{gcp_name_short}}"}} REST Resource Documentation</td>
-<td><a href="/dataform/docs/api/reference/rest/v1beta1/projects.locations.repositoriess">/dataform/docs/reference/rest/v1beta1/projects.locations.repositories</a></td>
+<td><a href="/dataform/docs/api/reference/rest/v1beta1/projects.locations.repositories">/dataform/docs/reference/rest/v1beta1/projects.locations.repositories</a></td>


yuwenma · 2024-11-13T05:37:28Z

Thank you @jsoref , very impressive!

I left two comments, please take a look.

yuwenma · 2024-11-14T20:41:05Z

Hi @jsoref, the repo is developing quickly. Do you think it's possible to split this PR into smaller ones so that the fix can go in quicker? Otherwise, you have to keep on resolving merge conflicts.

jsoref · 2024-11-14T21:05:42Z

I'm happy to do either. Suggest a split?

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

jsoref · 2024-11-19T14:29:37Z

This is a full rebase. There are ~220 commits total. including ~15 link fixes at the top.

I'll try splitting off the link fixes and the first 52 commits and we can see if that's easier...

yuwenma · 2024-11-20T01:45:35Z

This is a full rebase. There are ~220 commits total. including ~15 link fixes at the top.

I'll try splitting off the link fixes and the first 52 commits and we can see if that's easier...

Sounds good. #3195 is a good start!

jsoref · 2024-11-20T03:26:22Z

Ok, let's use ~20 commits at a time, that seems digestible.

In the end, the few items that can't make it due to dependencies can come along in this PR.

google-oss-prow bot added the do-not-merge/work-in-progress label Oct 31, 2024

jsoref commented Oct 31, 2024

View reviewed changes

jsoref changed the title ~~Spelling~~ [CHORE] Spelling Oct 31, 2024

jsoref force-pushed the spelling branch from ceacc1c to 956ade0 Compare November 1, 2024 13:16

jsoref marked this pull request as ready for review November 1, 2024 13:16

google-oss-prow bot removed the do-not-merge/work-in-progress label Nov 1, 2024

jsoref force-pushed the spelling branch from 956ade0 to 4c7a9af Compare November 13, 2024 13:15

jsoref added 19 commits November 19, 2024 09:25

spelling: abandon

a9e2cb9

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

spelling: accessible

ea0de9a

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

spelling: account

6202431

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

spelling: acquiring

2fe1c88

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

spelling: actual

37e73a7

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

spelling: actuation

e7acd04

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

spelling: already

7db79b5

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

spelling: ambiguous

7282ed3

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

spelling: an

ee4468a

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

spelling: analyze

f312040

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

spelling: and

8a3fee9

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

spelling: annotation composition

8c3960a

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

spelling: annotation

f001367

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

spelling: associated

2ec890c

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

spelling: asymptotic

794cbae

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

spelling: autopilot

f438d66

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

spelling: availability

c79138d

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

spelling: available

9355b44

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

spelling: behavior

cab778a

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

jsoref added 12 commits November 19, 2024 09:26

Avoid here links: contributing to projects

5f3fa01

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

Avoid here links: details about the Absent behavior

ec9b132

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

Avoid here links: generated

7b378c1

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

Avoid here links: how app engine requests are routed

a72dc54

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

Avoid here links: instructions

0dc3afe

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

Avoid here links: list of available properties

32af8b1

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

Avoid here links: list of the available pre-defined roles

aebc1b3

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

Avoid here links: register the controller

489eba4

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

Avoid here links: resource reference guidelines

eb6986d

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

Avoid here links: sample guidelines

ffd9ca2

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

Avoid here links: supported formats

cb4193a

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

Avoid here links: understanding roles

c01d6ca

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

jsoref force-pushed the spelling branch from 4c7a9af to c01d6ca Compare November 19, 2024 14:27

jsoref force-pushed the spelling branch from c01d6ca to 46b95a7 Compare November 19, 2024 14:29

jsoref mentioned this pull request Nov 19, 2024

[CHORE] Avoid here links #3195

Merged

2 tasks

jsoref requested a review from yuwenma November 19, 2024 14:36

This was referenced Nov 20, 2024

[CHORE] Spelling 1/n #3204

Open

[CHORE] Spelling 2/n #3205

Merged

[CHORE] Spelling 3/n #3206

Open

[CHORE] Spelling 4/n #3207

Merged

[CHORE] Spelling 5/n #3208

Merged

This was referenced Nov 20, 2024

[CHORE] Spelling 6/n #3214

Open

[CHORE] Spelling 7/n #3215

Open

[CHORE] Spelling 8/n #3216

Open

[CHORE] Spelling 9/n #3217

Open

[CHORE] Spelling 10/n #3218

Merged

[CHORE] Spelling 11/n #3219

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[CHORE] Spelling #3062

[CHORE] Spelling #3062

jsoref commented Oct 31, 2024 •

edited

Loading

google-oss-prow bot commented Oct 31, 2024

jsoref Oct 31, 2024

jsoref Oct 31, 2024

jsoref Oct 31, 2024

jsoref Oct 31, 2024

jsoref Oct 31, 2024

jsoref Oct 31, 2024

jsoref Oct 31, 2024

jsoref Oct 31, 2024

yuwenma commented Nov 13, 2024 •

edited

Loading

yuwenma commented Nov 14, 2024

jsoref commented Nov 14, 2024

jsoref commented Nov 19, 2024

yuwenma commented Nov 20, 2024

jsoref commented Nov 20, 2024 •

edited

Loading

[CHORE] Spelling #3062

Are you sure you want to change the base?

[CHORE] Spelling #3062

Conversation

jsoref commented Oct 31, 2024 • edited Loading

Change description

Tests you have done

google-oss-prow bot commented Oct 31, 2024

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

yuwenma commented Nov 13, 2024 • edited Loading

yuwenma commented Nov 14, 2024

jsoref commented Nov 14, 2024

jsoref commented Nov 19, 2024

yuwenma commented Nov 20, 2024

jsoref commented Nov 20, 2024 • edited Loading

jsoref commented Oct 31, 2024 •

edited

Loading

yuwenma commented Nov 13, 2024 •

edited

Loading

jsoref commented Nov 20, 2024 •

edited

Loading