-
Notifications
You must be signed in to change notification settings - Fork 242
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[CHORE] Spelling #3062
base: master
Are you sure you want to change the base?
[CHORE] Spelling #3062
Changes from all commits
a9e2cb9
ea0de9a
6202431
2fe1c88
37e73a7
e7acd04
7db79b5
7282ed3
ee4468a
f312040
8a3fee9
8c3960a
f001367
2ec890c
794cbae
f438d66
c79138d
9355b44
cab778a
f969935
9849768
454523a
285c9d7
361062e
c388d99
9caa743
0303418
0cb8f6d
0666cd3
b95745e
5577462
9de5a28
5c3ad87
f1f5878
10602e2
b920d5b
15178ca
fb0e2a8
2a5cfce
024cb8e
2e67409
3877b58
88c9b39
e2c5b86
59d4c42
13294f0
a72aa0a
3e12b62
48ed3bc
8362149
2fc5bdf
46b95a7
1edd881
bc6fdb0
c38d4ce
56943e9
db164e0
3d8c628
9081099
51ce5b2
82ea06b
be69c46
a68bef1
af71083
fc2bfec
35d6711
ecec377
296e0c1
7524e23
8d1faa3
a86b996
b68a2b7
d0ce823
49494d4
77592ee
475ecf6
c803595
d433500
11cd470
43f5f6c
602f7cf
ea4a461
b10357e
b6b1463
d8534e0
3e816dc
6b0b2aa
bd03fb0
41386b0
3611c6c
0535056
511094f
7f3420a
cab163e
7bcfb06
bf6abcb
887c75b
c33b6f7
3696492
3544b7e
b8c3bce
ab48a2d
21d7bc5
a2ac55e
a2d8ca1
753b85b
4b944b0
36b4061
2a4b440
af1daa6
2c2aeb5
68bb231
91db460
d27464f
abcf68d
4021520
8d5d0d4
6a6e1dd
0d20b82
c31b491
3923054
132dcfb
6cf2aba
23b1f52
8b26dde
df3b697
30c73b6
0d3bf2a
115febf
e50fa86
6a28647
f6f1a12
bd711f2
01c8f7c
257bb1c
e2ea645
cc5b8d1
df8bffb
d52d5b3
eb0c8a8
8ffed6d
55571a3
90a5ef8
c38616a
00e688a
3f8c141
aa7b11f
d6eff39
ab520f5
faf85c8
36f587b
455f396
ec74359
3bbfad2
95e0be9
cbbd702
b9beb0c
af00bed
93de95b
8d1d829
be2bd90
5273968
c43d5b4
8f671d7
72f1964
502db00
dc3e891
e62ba4c
cb5f2f5
9466188
4d48677
274c13b
f45a70b
469752d
0f8259a
266ff87
1d87e7a
17dcaa1
a4729e8
ddf87c8
1891e97
67a713f
32bc977
643fa6d
eba7cd7
2dfc0af
22b778a
c0bebed
9594e61
5c4c4b1
a78e88c
fd0271b
0aa1846
bec4c76
a716ea4
c5fe789
d585a32
e3e5472
2b3e7c8
a725a68
134149e
49c618d
88752ad
c05a520
27afc99
864b1a7
318ba36
5f3fa01
ec9b132
7b378c1
a72dc54
0dc3afe
32af8b1
aebc1b3
489eba4
eb6986d
ffd9ca2
cb4193a
c01d6ca
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
mirrored to internal Google repository for the purposes of releases. | ||
|
||
## Contributor License Agreement | ||
|
@@ -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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
following to ensure you have set up sudoless docker correctly: | ||
|
||
```shell | ||
|
@@ -149,7 +149,7 @@ repo to quickly set up a local dev environment. | |
```shell | ||
./gcp-setup.sh | ||
``` | ||
1. _(Optional)_ Verify that worload identity federation is [setup correctly](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity#verify_the_setup). | ||
1. _(Optional)_ Verify that workload identity federation is [setup correctly](https://cloud.google.com/kubernetes-engine/docs/how-to/workload-identity#verify_the_setup). | ||
|
||
1. Now that you have everything set up, you can build your own images and then | ||
deploy the Config Connector CRDs and workloads (including controller | ||
|
@@ -200,7 +200,7 @@ repo to quickly set up a local dev environment. | |
The script `gcp-setup.sh` annotates your `default` namespace in the GKE cluster | ||
with a | ||
[project-id](https://cloud.google.com/config-connector/docs/how-to/organizing-resources/project-scoped-resources#annotate_namespace_configuration) | ||
annotation equals to your default GCP project id in gcloud. This enables Config | ||
annotation equal to your default GCP project id in gcloud. This enables Config | ||
Connector to create GCP resources in that default GCP project. We can validate | ||
by creating an Artifact Registry resource through Config Connector. | ||
|
||
|
@@ -232,8 +232,7 @@ by creating an Artifact Registry resource through Config Connector. | |
|
||
#### Looking for error logs | ||
|
||
You can look for error logs by checking the controller logs following the steps | ||
[here](https://cloud.google.com/config-connector/docs/troubleshooting#check-controller-logs). | ||
You can look for error logs by checking the controller logs following the [troubleshooting](https://cloud.google.com/config-connector/docs/troubleshooting#check-controller-logs). | ||
|
||
#### Pods fail to pull image | ||
When the cluster is created without providing a service account, a Compute Engine service account is created for the cluster. Users must grant the service account permission to pull images from the project registry. | ||
|
@@ -367,14 +366,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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. check-spelling ignores 1 and 2 letter words -- changes in this file were by hand because I read the file... |
||
./pkg/test/resourcefixture/testdata/basic, you can run the test command directly | ||
to make sure the test can still pass. Example command: | ||
|
||
```bash | ||
# 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 | ||
``` | ||
Comment on lines
-375
to
+376
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The indentation here didn't match the rest of the file... |
||
Replace `cloudschedulerjob` with your test target. | ||
|
||
### Submit a Pull Request | ||
|
@@ -387,5 +386,5 @@ you can first validate the change locally: | |
make ready-pr | ||
``` | ||
|
||
You can then commit your change and make a pull request. See more details | ||
[here](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-and-pushing-changes). | ||
You can then commit your change and make a pull request. See [GitHub's contributing | ||
to projects: making and pushing changes](https://docs.github.com/en/get-started/quickstart/contributing-to-projects#making-and-pushing-changes). |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -62,7 +62,7 @@ Once it's determined, note down the field name and the referenced GCP resource n | |
|
||
Before you can identify what the resource is based on, you must convert | ||
the Google Cloud resource name or Terraform type name into a | ||
Config Connector kind name. Create a Github question in this repo for help | ||
Config Connector kind name. Create a GitHub question in this repo for help | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There were a number of brands, I'm not going to tag them all... |
||
if you still can't find the Config Connector kind name after following these steps: | ||
|
||
1. If you know the TF type name, you can do project-scoped search in your local | ||
|
@@ -80,7 +80,7 @@ if you still can't find the Config Connector kind name after following these ste | |
[KCC reference doc](https://cloud.google.com/config-connector/docs/reference/overview). | ||
|
||
1. If you can't find a KCC kind with the steps above, it's possible that the | ||
referenced resource is not supported in KCC. Create a Github question in this repo | ||
referenced resource is not supported in KCC. Create a GitHub question in this repo | ||
to clarify. If you've determined that the KCC kind is not supported in | ||
KCC, skip ahead to | ||
[Configure reference resource in the service mappings](#configure-reference-in-the-service-mappings). | ||
|
@@ -119,10 +119,10 @@ You can find a `Type` field for each argument, and two most common types are | |
|
||
1. If the field is not required, mark it as an ignored field following | ||
[this example](https://github.com/GoogleCloudPlatform/k8s-config-connector/blob/b746248cd5a9b30669380513de8fdc6b4c43018d/config/servicemappings/cloudbuild.yaml#L204). | ||
1. If the field is required, create a Github question in this repo for | ||
1. If the field is required, create a GitHub question in this repo for | ||
further discussion. | ||
|
||
1. If the field isn't a string or a list, create a Github question in this repo | ||
1. If the field isn't a string or a list, create a GitHub question in this repo | ||
for further discussion. | ||
|
||
## Configure reference resource in the service mappings | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -256,7 +256,7 @@ type DataflowFlexTemplateJobObservedState struct { | |
// Flexible resource scheduling jobs are started with some delay after job | ||
// creation, so start_time is unset before start and is updated when the | ||
// job is started by the Cloud Dataflow service. For other jobs, start_time | ||
// always equals to create_time and is immutable and set by the Cloud Dataflow | ||
// always equals create_time and is immutable and set by the Cloud Dataflow | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. it should either be |
||
// service. | ||
StartTime *string `json:"startTime,omitempty"` | ||
|
||
|
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
brand