diff --git a/canary-checker/docs/concepts/cli.mdx b/canary-checker/docs/concepts/cli.mdx index 808c7a25..3700bdfe 100644 --- a/canary-checker/docs/concepts/cli.mdx +++ b/canary-checker/docs/concepts/cli.mdx @@ -21,7 +21,7 @@ kubectl get canaries -o wide ## Scaling -Canaries can be scaled up or down just like other kubernetes resources. However, scaling to more than one replica is identical to having just one replica. In other words, scaling a canary can be thought of as a mechanism to turn on/off the canary. +Canaries can be scaled up or down like other Kubernetes resources. However, scaling to more than one replica is identical to having one replica. In other words, scaling a canary can be thought of as a mechanism to turn on/off the canary. @@ -40,7 +40,7 @@ kubectl get canaries folder-pass -o wide -This effectively stops the canary from running. +This stops the canary from running. ```bash diff --git a/canary-checker/docs/database.md b/canary-checker/docs/database.md index 9650bb7f..b7a02131 100644 --- a/canary-checker/docs/database.md +++ b/canary-checker/docs/database.md @@ -43,13 +43,13 @@ db: # ... ``` -The helm chart will create a postgres server statefulset, with a random password and default port, along with a new database. +The helm chart creates a postgres server statefulset, with a random password and default port, along with a new database. To specify a username and password for the chart-managed Postgres server, create a secret in the namespace that the chart will install to, named `postgres-connection`, which contains `POSTGRES_USER` and `POSTGRES_PASSWORD` keys. ## Connecting to an existing database -In order to connect to an existing Postgres server, a database must be created on the server, along with a user that has administrator permissions for the database. +To connect to an existing Postgres server, a database must be created on the server, along with a user that has administrator permissions for the database. ```yaml title="values.yaml" db: diff --git a/canary-checker/docs/reference/1-http.mdx b/canary-checker/docs/reference/1-http.mdx index 3869acd1..da645806 100644 --- a/canary-checker/docs/reference/1-http.mdx +++ b/canary-checker/docs/reference/1-http.mdx @@ -5,7 +5,7 @@ sidebar_class_name: popular # HTTP -This check performs queries on HTTP endpoints, and HTTP Namespaces to monitor their activity. +This check performs queries on HTTP endpoints, and HTTP namespaces to monitor their activity. ```yaml title=http-check.yaml apiVersion: canaries.flanksource.com/v1 @@ -27,8 +27,8 @@ spec: {field: "method", description: "HTTP Request method", default: "GET", scheme: "string"}, {field: "headers", description: "Header fields", scheme: "map[string]string"}, {field: "body", description: "Request Body Contents", scheme: "string"}, - {field: "tlsConfig", description: "TLS Config", scheme: "[TLSConfig](#tls-config)"}, - {field: "templateBody", description: "If true body will be templated", default: false, scheme: "bool"}, + {field: "tlsConfig", description: "TLS config", scheme: "[TLSConfig](#tls-config)"}, + {field: "templateBody", description: "If true body is templated", default: false, scheme: "bool"}, {field: "responseCodes", description: "Expected response codes", scheme: "[]int"}, {field: "responseContent", description: "Expected response content", scheme: "string"}, {field: "thresholdMillis", description: "Request timeout", default: 5000, scheme: "int"}, @@ -42,7 +42,7 @@ spec: {field: "ca", description: "PEM encoded certificate of the CA to verify the server certificate", scheme: "EnvVar"}, {field: "cert", description: "PEM encoded client certificate", scheme: "EnvVar"}, {field: "key", description: "PEM encoded client private key", scheme: "EnvVar"}, - {field: "handshakeTimeout", description: "Timeout for SSL Handshake (defaults to 10 seconds)", scheme: "int"}, + {field: "handshakeTimeout", description: "Timeout for SSL handshake (defaults to 10 seconds)", scheme: "int"}, {field: "insecureSkipVerify", description: "Controls whether a client verifies the server's certificate chain and host name", scheme: "bool"} ]}/> @@ -114,7 +114,7 @@ spec: | Name | Scheme | | ----------------------------- | ------------------- | | `metadata.name` | string | -| `metadata.metadata.namespace` | _string_ | +| `metadata.namespace` | _string_ | | `metadata.labels` | _map[string]string_ | | `{fields from []env}` | any | diff --git a/canary-checker/docs/reference/1-kubernetes-resource.mdx b/canary-checker/docs/reference/1-kubernetes-resource.mdx index 36466f86..a8c6e172 100644 --- a/canary-checker/docs/reference/1-kubernetes-resource.mdx +++ b/canary-checker/docs/reference/1-kubernetes-resource.mdx @@ -43,9 +43,9 @@ check would be to see if a service is accessible via the ingress as shown in the { field: 'clearResources', scheme: 'bool', - description: `When set to true, resources from previous checks will be deleted before every run. - Even though the resources are deleted at the end of a check, setting this to \`true\` will guarantee that - there are no remains from a previous failed run.` + description: `When set to true, resources from previous checks are deleted before every run. + Even though the resources are deleted at the end of a check, setting this to \`true\` guarantees that + there are no leftover resources from a previous failed run.` }, { field: 'waitFor', @@ -147,7 +147,7 @@ Templating the **Group**, **Version**, **Kind** & **Namespace** however isn't al :::warning Since static resources are deleted when the canary is deleted, extra care must be taken when providing their manifests. -When this canary is deleted, the **test** namespace will be deleted and consequently all the other resources within it, even those not created by this check. +When this canary is deleted, the **test** namespace is deleted and consequently all the other resources within it, even those not created by this check. ::: diff --git a/canary-checker/docs/reference/1-pod.mdx b/canary-checker/docs/reference/1-pod.mdx index 292c8f44..dc594a96 100644 --- a/canary-checker/docs/reference/1-pod.mdx +++ b/canary-checker/docs/reference/1-pod.mdx @@ -7,19 +7,16 @@ tags: # Pod - - -The Pod check creates a new pod and verifies its reachability. - +The Pod check creates a new pod and verifies that it can be reached via an Ingress ```yaml title="tcp.yaml" file=../../../modules/canary-checker/fixtures/k8s/pod_pass.yaml ``` bool @@ -562,9 +558,7 @@ sets.equivalent([1, 2, 3], [3u, 2.0, 1]) // true ### sets.intersects -Returns whether the first list has at least one element whose value is equal -to an element in the second list. If either list is empty, the result will -be false. +Returns whether the first list has at least one element whose value is equal to an element in the second list. If either list is empty, the result is false. ```javascript sets.intersects([1], []) // false @@ -1011,8 +1005,8 @@ separating them with an OS specific Separator. Empty elements are ignored. The result is Cleaned. However, if the argument list is empty or all its elements are empty, Join returns an empty string. -On Windows, the result will only be a UNC path if the first -non-empty element is a UNC path addict. +On Windows, the result is only a UNC path if the first +non-empty element is a UNC path. ```javascript filepath.Join(["/home/flanksource", "projects", "gencel"]; // /home/flanksource/projects/gencel @@ -1710,7 +1704,7 @@ regexp.Split("z", -1, "hello") // ["hello"] ### .abbrev `abbrev` on a string abbreviates the string using ellipses. This will turn the string "Now is the time for all good men" into "...s the time for..." -This function works like `Abbreviate(string, int)`, but allows you to specify a "left edge" offset. Note that this left edge is not +This function works like `Abbreviate(string, int)`, but allows you to specify a "left edge" offset. The left edge is not necessarily going to be the leftmost character in the result, or the first character following the ellipses, but it will appear somewhere in the result. In no case will it return a string of length greater than maxWidth. @@ -1796,7 +1790,7 @@ The valid formatting clauses are: - `%s` substitutes a string. This can also be used on `bools`, `lists`, `maps`, `bytes`, `Duration`, `Timestamp`,`int`, `double` -
Note that the dot/period decimal separator will always be used when printing a list or map that contains a double, and that null can be passed (which results in the string "null") in addition to types. +
the dot/period decimal separator will always be used when printing a list or map that contains a double, and that null can be passed (which results in the string "null") in addition to types. - `%d` substitutes an integer. - `%f` substitutes a double with fixed-point precision. The default precision is 6, but this can be adjusted. The strings `Infinity`, `-Infinity`, and `NaN` are also valid input for this clause. - `%e` substitutes a double in scientific notation. The default precision is 6, but this can be adjusted. diff --git a/canary-checker/docs/scripting/gotemplate.mdx b/canary-checker/docs/scripting/gotemplate.mdx index 3fcdf165..307feecf 100644 --- a/canary-checker/docs/scripting/gotemplate.mdx +++ b/canary-checker/docs/scripting/gotemplate.mdx @@ -45,7 +45,7 @@ Decode a Base64 string. This supports both standard ([RFC4648 §4](https://t ``` :::note -For the functions that return an array, a Go `[]interface{}` is returned, regardless of whether or not the input was a different type. +For the functions that return an array, a Go `[]interface{}` is returned, regardless of whether the input was a different type. ::: ## Collection diff --git a/fix.sh b/fix.sh new file mode 100755 index 00000000..e4d74089 --- /dev/null +++ b/fix.sh @@ -0,0 +1,5 @@ +#!/bin/bash + + + vale --output=JSON $1 > vale.json + aider --no-git $1 vale.json -m "As a technical editor for developer tool documentation, Fix any issues detected in $1 by using the scan results in vale.json, do not make changes to anything quoted using \` or \`\`\`. do not remove '//' if found at the start of a line or in the middle of a line. Do not modify any whitespace. Only modify the content based on suggestions in vale.json. DO not modify lines that start with '{{' or lines that look like code. Only modify english sentances. Stop after 20 fixes" diff --git a/styles/ignore/words-with-suggestions.txt b/styles/ignore/words-with-suggestions.txt index a68e05a5..3aa6e042 100644 --- a/styles/ignore/words-with-suggestions.txt +++ b/styles/ignore/words-with-suggestions.txt @@ -316,3 +316,24 @@ Youtube yq CRD's Zulip +HTTPConnection +scheduleTimeout +expectedContent +expectedHttpStatuses +readyTimeout +scheduleTimeout +httpTimeout +deleteTimeout +ingressTimeout +deadline +httpRetryInterval +ingressName +ingressHost +priorityClass +handshakeTimeout +tlsConfig +templateBody +responseCodes +responseContent +thresholdMillis +maxSSLExpiry