-
Notifications
You must be signed in to change notification settings - Fork 0
Test Vale errors and warnings #6
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
Changes from all commits
8cbc302
11568b5
d592565
ac542fc
4df9f38
f8ddc4b
59675d9
43316af
fccfc7f
2377d83
65ffead
8328f08
6441ec5
ce7dc17
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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -7,17 +7,17 @@ scope: operator | |||||
|
|
||||||
| ## Create a Shoot Cluster | ||||||
|
|
||||||
| As you have already prepared an [example Shoot manifest](https://github.com/gardener/gardener/blob/master/example/90-shoot.yaml) in the steps described in the development documentation, please open another Terminal pane/window with the `KUBECONFIG` environment variable pointing to the Garden development cluster and send the manifest to the Kubernetes API server: | ||||||
| As you have already prepared an [example Shoot manifest](https://github.com/gardener/gardener/blob/master/example/90-shoot.yaml) in the steps described in the development documentation, please open another Terminal pane/window with the `KUBECONFIG` environment variable pointing to the Garden development cluster and send the manifest to the kubernetes API server: | ||||||
|
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. 🚫 [vale] reported by reviewdog 🐶 |
||||||
|
|
||||||
| ```bash | ||||||
| kubectl apply -f your-shoot-aws.yaml | ||||||
| ``` | ||||||
|
|
||||||
| You should see that Gardener has immediately picked up your manifest and has started to deploy the Shoot cluster. | ||||||
| You should see that gardener has immediately picked up your manifest and has started to deploy the controlplane of the Shoot cluster. | ||||||
|
BoHristova marked this conversation as resolved.
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. 🚫 [vale] reported by reviewdog 🐶 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. 🚫 [vale] reported by reviewdog 🐶 |
||||||
|
|
||||||
| In order to investigate what is happening in the Seed cluster, please download its proper Kubeconfig yourself (see next paragraph). The namespace of the Shoot cluster in the Seed cluster will look like that: `shoot-johndoe-johndoe-1`, whereas the first `johndoe` is your namespace in the Garden cluster (also called "project") and the `johndoe-1` suffix is the actual name of the Shoot cluster. | ||||||
|
|
||||||
| To connect to the newly created Shoot cluster, you must download its Kubeconfig as well. Please connect to the proper Seed cluster, navigate to the Shoot namespace, and download the Kubeconfig from the `kubecfg` secret in that namespace. | ||||||
| To connect to the newly created Shoot cluster, the user must download its Kubeconfig as well. Please connect to the proper Seed cluster, navigate to the Shoot namespace, and download the Kubeconfig from the `kubecfg` secret in that namespace. This requires a SSH connection to the seed. Note that a VM is also provisioned per worker pool. | ||||||
|
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 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.
|
||||||
|
|
||||||
| ## Delete a Shoot Cluster | ||||||
|
|
||||||
|
|
@@ -27,7 +27,7 @@ In order to delete your cluster, you have to set an annotation confirming the de | |||||
| ./hack/usage/delete shoot johndoe-1 johndoe | ||||||
| ``` | ||||||
|
|
||||||
| (the `hack` bash script can be found at [GitHub](https://github.com/gardener/gardener/blob/master/hack/usage/delete)) | ||||||
| (the `hack` bash script can be found at [Github](https://github.com/gardener/gardener/blob/master/hack/usage/delete)) | ||||||
|
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. Use official capitalization: Please change 🧰 Tools🪛 LanguageTool[uncategorized] ~30-~30: The official name of this software platform is spelled with a capital “H”. (GITHUB) 🤖 Prompt for AI Agents |
||||||
|
|
||||||
| ## Configure a Shoot Cluster Alert Receiver | ||||||
|
|
||||||
|
|
@@ -36,3 +36,11 @@ The receiver of the Shoot alerts can be configured from the `.spec.monitoring.al | |||||
| The alerting for the Shoot clusters is handled by the Prometheus Alertmanager. The Alertmanager will be deployed next to the control plane when the `Shoot` resource specifies `.spec.monitoring.alerting.emailReceivers` and if a [SMTP secret](https://github.com/gardener/gardener/blob/master/example/10-secret-alerting.yaml) exists. | ||||||
|
|
||||||
| If the field gets removed then the Alertmanager will be also removed during the next reconcilation of the cluster. The opposite is also valid if the field is added to an existing cluster. | ||||||
|
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. Fix spelling: 'reconciliation'. The word 'reconcilation' is misspelled. 📝 Proposed fix-If the field gets removed then the Alertmanager will be also removed during the next reconcilation of the cluster. The opposite is also valid if the field is added to an existing cluster.
+If the field gets removed then the Alertmanager will be also removed during the next reconciliation of the cluster. The opposite is also valid if the field is added to an existing cluster.As per coding guidelines, Vale correctly flags this: Did you really mean 'reconcilation'? (Gardener.Spelling). 📝 Committable suggestion
Suggested change
🧰 Tools🪛 GitHub Actions: Vale / 0_Lint prose.txt[error] 38-38: vale: Did you really mean 'reconcilation'? (Gardener.Spelling). 🪛 GitHub Actions: Vale / Lint prose[error] 38-38: Vale error: Did you really mean 'reconcilation'? (Gardener.Spelling) 🪛 LanguageTool[grammar] ~38-~38: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) |
||||||
|
|
||||||
| ## Additional Notes | ||||||
|
|
||||||
| You can configure an VM instance type for each worker pool. The shoot controller uses a URL-rewriting proxy — make sure you pass an URL to the configuration. For logging, the stack relies on Fluentbit to ship logs to the central backend. See the Github releases page for the latest version of the shoot-oidc-service. | ||||||
|
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. Fix multiple grammar and product name issues. This line has several issues:
📝 Proposed fix-You can configure an VM instance type for each worker pool. The shoot controller uses a URL-rewriting proxy — make sure you pass an URL to the configuration. For logging, the stack relies on Fluentbit to ship logs to the central backend. See the Github releases page for the latest version of the shoot-oidc-service.
+You can configure a VM instance type for each worker pool. The shoot controller uses a URL-rewriting proxy — make sure you pass a URL to the configuration. For logging, the stack relies on Fluent Bit to ship logs to the central backend. See the GitHub releases page for the latest version of the shoot-oidc-service.As per coding guidelines, Vale correctly flags: Did you really mean 'Fluentbit'? (Gardener.Spelling) and Use 'GitHub' instead of 'Github' (Gardener.Terms). 📝 Committable suggestion
Suggested change
🧰 Tools🪛 GitHub Actions: Vale / 0_Lint prose.txt[error] 42-42: vale: Did you really mean 'Fluentbit'? (Gardener.Spelling). [error] 42-42: vale: Did you really mean 'Github'? (Gardener.Spelling). Use 'GitHub' instead of 'Github'. 🪛 GitHub Actions: Vale / Lint prose[error] 42-42: Vale error: Did you really mean 'Fluentbit'? (Gardener.Spelling) [error] 42-42: Vale error: Use 'GitHub' instead of 'Github'. (Gardener.Spelling, Gardener.Terms) |
||||||
|
|
||||||
| Please ensure the user has to verify the correct RBAC permissions before proceeding. | ||||||
|
|
||||||
| The reconcilation process will also check for Loadbalancer availability in the target zone. | ||||||
|
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. Fix spelling and capitalization. Two issues on this line:
📝 Proposed fix-The reconcilation process will also check for Loadbalancer availability in the target zone.
+The reconciliation process will also check for load balancer availability in the target zone.As per coding guidelines, Vale correctly flags these: Did you really mean 'reconcilation'? (Gardener.Spelling) and Use 'load balancer' instead of 'Loadbalancer' (Gardener.Terms). 📝 Committable suggestion
Suggested change
🧰 Tools🪛 GitHub Actions: Vale / 0_Lint prose.txt[error] 46-46: vale: Did you really mean 'reconcilation'? (Gardener.Spelling). [error] 46-46: vale: Did you really mean 'Loadbalancer'? (Gardener.Spelling). 🪛 GitHub Actions: Vale / Lint prose[error] 46-46: Vale error: Did you really mean 'reconcilation'? (Gardener.Spelling) [error] 46-46: Vale error: Did you really mean 'Loadbalancer'? Use 'Load balancer' instead. (Gardener.Spelling, Gardener.Terms) 🪛 LanguageTool[grammar] ~46-~46: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) |
||||||
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.
path_instructionswon’t run whilewebsite/**is excluded bypath_filters.Because Line 4 excludes
website/**, this newwebsite/**/*.mdinstruction block is effectively unreachable. If the goal is to apply Vale-aware review behavior to docs, remove or narrow that exclusion.Suggested config fix