chore: fix vale suggestions

canary-checker/docs/database.md

@@ -45,7 +45,7 @@ db:
 
 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.
+To specify a username and password for the chart-managed Postgres server, create a secret in the namespace that the chart installs to, named `postgres-connection`, which contains `POSTGRES_USER` and `POSTGRES_PASSWORD` keys.
 
 ## Connecting to an existing database
 

canary-checker/docs/getting-started.mdx

@@ -80,7 +80,7 @@ The canary checker itself only presents an API. To view the data graphically, th
 
 | Parameter                          | Description                                                   |
 |------------------------------------|---------------------------------------------------------------|
-| `flanksource-ui.ingress.host`      | URL at which the UI will be accessed                          |
+| `flanksource-ui.ingress.host`      | URL at which the UI is accessed                          |
 | `flanksource-ui.ingress.annotations` | Map of annotations required by the ingress controller or certificate issuer |
 | `flanksource-ui.ingress.tls`       | Map of configuration options for TLS                          |
 
@@ -96,5 +96,4 @@ If you have any questions about canary checker:
 * File an [issue](https://github.com/flanksource/canary-checker/issues/new) - (We do provide user support via Github Issues, so don't worry  if your issue a real bug or not)
 * [Flanksource](https://www.flanksource.com) provides both commercial support for canary checker and a SaaS offering called Mission Control.
 
-Your feedback is always welcome!
-
+Your feedback is always welcome.

canary-checker/docs/health-checks.mc.mdx

@@ -9,7 +9,7 @@ title: Health Checks
 <img src="/img/health-checks.svg" style={{width: "900px"}}/>
 
 
-Mission control provides the ability to define and run periodic health checks against services, infrastructure and applications.
+Mission control provides the ability to define and run periodic health checks against services, infrastructure, and applications.
 
 <Step step={1} name="Synthetic" style="list">
 Synthetic checks are periodically run by canary checker to directly test services/applications by generating requests using http, sql, mongo, redis, ldap, etc.
@@ -46,14 +46,14 @@ Evaluate the health of checks using scripts in CEL, Javascript or Go Templating.
 ## Dashboard
 
 <Step step={1} name="Dashboard" style="list">
-The health checks page provides a high level view of the overall health of all services, infrastructure and applications. It surfaces recent failures and provides a high level latency and reliability metrics.
+The health checks page provides a high level view of the overall health of all services, infrastructure, and applications. It surfaces recent failures and provides a high level latency and reliability metrics.
 
 ![](./images/canary-dashboard.png)
 </Step>
 
 <Step step={2} name="Topology" style="list">
 
-Health checks can be associated with components in a [topology](topology/concepts/health-checks) and will then show up in the topology card:
+Health checks can be associated with components in a [topology](topology/concepts/health-checks) and then shows up in the topology card:
 
 ![](./images/topology-health-checks.png)
 </Step>

canary-checker/docs/reference/1-alert-manager.mdx

@@ -8,7 +8,7 @@ sidebar_class_name: popular
 
 Checks [Prometheus AlertManager](https://prometheus.io/docs/alerting/latest/alertmanager/) for any firing alerts.
 
-The following example [transforms](../concepts/expressions/transforms) the list of alerts so that each alert becomes a single check result. Without the transform the health check will fail if any alerts are firing.
+The following example [transforms](../concepts/expressions/transforms) the list of alerts so that each alert becomes a single check result. Without the transform the health check fails if any alerts are firing.
 
 ```yaml title="alert-manager-check.yaml" file=../../../modules/canary-checker/fixtures/datasources/alertmanager_mix.yaml
 apiVersion: canaries.flanksource.com/v12

canary-checker/docs/reference/1-exec.mdx

@@ -40,7 +40,7 @@ See [image-variants](/reference/canary-checker/image-variants)
 },
 {
   field: "connections",
-  description: "Setup connections for the script (eg: aws credentials)",
+  description: "Setup connections for the script (e.g.: aws credentials)",
   scheme: "[`ExecConnection`](#exec-connection)",
 }
 ]}/>
@@ -57,8 +57,7 @@ See [image-variants](/reference/canary-checker/image-variants)
 <SkipOSS>
 ### Exec Connection
 
-Exec connections allow you to specify credentials for a list of CLI tools that are needed by your scripts. Eg: You can specify the AWS connection name and the credential files along with the necessary environment variables
-will be setup on the host running the script.
+Exec connections allow you to specify credentials for a list of CLI tools that are needed by your scripts. Eg: You can specify the AWS connection name and the credential files along with the necessary environment variables are setup on the host running the script.
 
 | Field   | Description      | Type                                                    | Required |
 | ------- | ---------------- | ------------------------------------------------------- | -------- |
@@ -104,6 +103,6 @@ See [artifacts](/installation/artifacts)
 </details>
 
 <Fields connection="git" rows={[
-  {field: "destination", description: "Destination is the full path to where the contents of the URL should be downloaded to. If left empty, the sha256 hash of the URL will be used as the dir name", type: "string"},
+  {field: "destination", description: "Destination is the full path to where the contents of the URL should be downloaded to. If left empty, the sha256 hash of the URL is used as the dir name", type: "string"},
 ]}/>
 

canary-checker/docs/reference/1-folder.mdx

@@ -4,7 +4,7 @@ title: Folder
 
 # <Icon name="smb" /> Folder
 
-Checks the contents of a folder for size, age and count. Folder based checks are useful in a number of scenarios:
+Checks the contents of a folder for size, age, and count. Folder based checks are useful in a number of scenarios:
 
 - Verifying that backups have been uploaded and are the appropriate size
 - Checking that logs or other temporary files are being cleaned up
@@ -43,7 +43,7 @@ spec:
   {field: "minAge", description: "The youngest age a file can be", scheme: "Duration"},
   {field: "maxAge", description: "The oldest age a file can be, often used to check for unprocessed files or files that have not been cleaned up", scheme: "Duration"},
   {field: "minSize", description: "The minimum file size, can be used to detect backups that did not upload successfully", scheme: "Size"},
-  {field: "maxSize", description: "The maximim file size", scheme: "Size"}
+  {field: "maxSize", description: "The maximum file size", scheme: "Size"}
 
 ]}/>
 

canary-checker/docs/reference/1-http.mdx

@@ -118,7 +118,7 @@ spec:
 | `metadata.labels`             | _map[string]string_ |
 | `{fields from []env}`         | any                 |
 
-Variables defined in `env` will be available to template with the name that's configured on the spec.
+Variables defined in `env` are available to template with the name that's configured on the spec.
 Eg: In the following spec, the vars `my_secret_path` and `my_secret_var`, defined in `env`, are available during templating.
 
 <details summary="Templating request body from env variables">

canary-checker/docs/reference/1-icmp.mdx

@@ -4,7 +4,7 @@ title: ICMP
 
 # <Icon name="icmp" /> ICMP
 
-Performs ICMP (ping) requests for information on ICMP packet loss, duration and response.
+Performs ICMP (ping) requests for information on ICMP packet loss, duration, and response.
 
 :::info
 Canary checker supports both `privileged` and `unprivileged` ping modes using the `PING_MODE` environment variable or `pingMode` helm value.

canary-checker/docs/reference/1-junit.mdx

@@ -66,7 +66,7 @@ JUnit check performs a Unit test, parses the JUnit test reports in a container a
 | `status`     | One of `passed`, `skipped`, `failed` or `error`         | _string_            |
 | `message`    | Description optionally included with a skipped,         | _string_            |
 | `properties` | Additional info about the test                          | `map[string]string` |
-| `error`      | Any errors encountered when running atest               | _string_            |
+| `error`      | Any errors encountered when running a test              | _string_            |
 | `stdout`     | Standard output produced during test                    | _string_            |
 | `stderr`     | Standard error output produced during test              | _string_            |
 

canary-checker/docs/reference/1-kubernetes.mdx

@@ -15,7 +15,7 @@ The Kubernetes check performs requests on Kubernetes resources such as Pods to g
   {field: "kind", description: "Kubernetes object kind", scheme: 'string', required: true},
   {field: "resource", description: " Queries resources related to specified Kubernetes object ", scheme: 'ResourceSelector'},
   {field: "namespaceSelector", description: "Namespace of the Kubernetes object",scheme: 'ResourceSelector'},
-  {field: "namespace", description: "Failing checks will be placed in this namespace, useful if you have shared namespaces"},
+  {field: "namespace", description: "Failing checks are placed in this namespace, useful if you have shared namespaces"},
   {field: "ignore", description: "Ignore the specified resources from the fetched resources. Can be a glob pattern.", scheme: '[]glob'},
   {field: "healthy", description: "Fail the check if any resources are unhealthy", scheme: 'bool'},
   {field: "ready", description: "Fail the check if any resources are not ready", scheme: 'bool'},

canary-checker/docs/reference/1-sql.mdx

@@ -6,7 +6,7 @@ import { AzureSqlServer} from "@flanksource/icons/mi"
 
 # <AzureSqlServer/> SQL
 
-This check will try to connect to a specified Postgres database, run a query against it and verify the results.
+This check connects to a specified Postgres database, run a query against it and verify the results.
 
 ```yaml
 apiVersion: canaries.flanksource.com/v1

canary-checker/docs/reference/3-containerd.mdx

@@ -6,7 +6,7 @@ sidebar_class_name: beta
 
 # <Icon name="containerd" /> ContainerD / Docker
 
-This check will try to pull a Docker image from specified registry using containerd and then verify its checksum and size.
+This check pulls a Docker image from specified registry using containerd and then verify its checksum and size.
 
 :::note Root Privileges Required
 The containerd and docker health checks require access to a working socket that is mounted at runtime
@@ -63,7 +63,7 @@ spec:
 
 ## Pushing images
 
-This check will try to push a Docker image to a specified registry using containerd.
+This check pushes a Docker image to a specified registry using containerd.
 
 ```yaml
 apiVersion: canaries.flanksource.com/v1

canary-checker/docs/reference/3-gcs-database-backup.mdx

@@ -24,7 +24,7 @@ spec:
 | Field         | Description                                                 | Scheme                                         | Required |
 | ------------- | ----------------------------------------------------------- | ---------------------------------------------- | -------- |
 | **`gcp`**     | Connect to GCP project and instance                         | [_GCPDatabase_](#gcpdatabase)                  | Yes      |
-| **`maxAge`**  | Max age for backup allowed, eg. 5h30m                       | _Duration_                                     |          |
+| **`maxAge`**  | Max age for backup allowed, e.g. 5h30m                       | _Duration_                                     |          |
 | **`name`**    | Name of the check, must be unique within the canary         | `string`                                       | Yes      |
 | `description` | Description for the check                                   | `string`                                       |          |
 | `icon`        | Icon for overwriting default icon on the dashboard          | `string`                                       |          |

canary-checker/docs/reference/3-namespace.mdx

@@ -61,15 +61,15 @@ spec:
 | `httpTimeout` |  | int64 |  |
 | `icon` | Icon for overwriting default icon on the dashboard | *string* |  |
 | `ingressHost` | URL to be used by the ingress to expose the created pod | *string* |  |
-| `ingressName` | Name to use for the ingress object that will expose the created pod | *string* |  |
+| `ingressName` | Name to use for the ingress object that exposes the created pod | *string* |  |
 | `ingressTimeout` | Maximum time to wait for an HTTP connection to the created pod | *int64* |  |
 | `name` | Name of the check | string |  |
 | `namespaceAnnotations` | Metadata annotations to apply to created namespace | *map[string]string* |  |
 | `namespaceLabels` | Metadata labels to apply to created namespace | *map[string]string* |  |
 | `namespaceNamePrefix` | Prefix string to identity namespace | *string* |  |
-| `path` | Path on which the created pod will respond to requests | *string* |  |
+| `path` | Path on which the created pod responds to requests | *string* |  |
 | **`podSpec`** | Spec of pod to be created in check namespace | *string* | Yes |
-|`port` | Port on which the created pod will serve traffic | *int64* |  |
+|`port` | Port on which the created pod serves traffic | *int64* |  |
 | `priorityClass` | Pod priority class | *string* |  |
 | `readyTimeout` | Specify readiness timeout for namespace | *int64* |  |
 | `scheduleTimeout` | Maximum time between pod created and pod running | *int64* |  |

canary-checker/docs/reference/3-restic.mdx

@@ -19,7 +19,7 @@ The Restic check:
 <HealthCheck name="redis" connection="url" rows={[
   {field: "repository", description: "The restic repository path e.g., `rest: https://user:pass@host:8000/` or rest: `https://host:8000/` or `s3:s3.amazonaws.com/bucket_name`", required: true},
   {field: "maxAge", description: "Max age for backup freshness check", required: true, scheme: "Duration"},
-  {field: "checkIntegrity", description: "When enabled will check the Integrity and consistency of the restic repository", scheme: "boolean"},
+  {field: "checkIntegrity", description: "When enabled it checks the Integrity and consistency of the restic repository", scheme: "boolean"},
   {field: "caCert", description: "Path to CA certificate for self-signed certificates", scheme: "string"},
   {field: "password", description: "Password for encrypted repositories", scheme: "EnvVar"},
   {field: "awsConnectionName", description: "AWS connection name for S3 repositories", scheme: "aws"}

canary-checker/docs/reference/_connections.mdx

@@ -141,7 +141,7 @@ spec:
 | Field        | Description                                                  | Scheme                                            |
 | ------------ | ------------------------------------------------------------ | ------------------------------------------------- |
 | `connection` | Path of existing connection e.g. `connection://sftp/instance`<br /> Mutually exclusive with `username` <br /><Commercial /> | <CommonLink to="connection" >*Connection*</CommonLink>          |
-| `username`   | utually exclusive with `connection`                          | <CommonLink to="authentication">*EnvVar*</CommonLink> |
+| `username`   | Mutually exclusive with `connection`                          | <CommonLink to="authentication">*EnvVar*</CommonLink> |
 | `password`   | <SkipOSS>Mutually exclusive with `connection`</SkipOSS>                           | <CommonLink to="authentication">*EnvVar*</CommonLink> |
 | `host`       | Custom AWS Cloudwatch endpoint                               | *string*                                          |
 | `port`       | Default to `22`                                              | int                                               |

canary-checker/docs/reference/jmeter.mdx

@@ -7,7 +7,7 @@ title: Jmeter
   <Standard />
   <FullImage />
 
-This check will execute the JMeter CLI to execute the JMX test plan on the specified host.
+This check executes the JMeter CLI to execute the JMX test plan on the specified host.
 
 ```yaml
 apiVersion: canaries.flanksource.com/v1

canary-checker/docs/troubleshooting.mdx

@@ -90,7 +90,7 @@ which results in an output similar to the below:
 ![](/img/trace-screenshot.png)
 
 :::danger Sensitive Data & Excessive Logging
-Trace level logging returns the HTTP response body which may contain sensitive data (The authorization headers will be sanitized)
+Trace level logging returns the HTTP response body which may contain sensitive data (The authorization headers are sanitized)
 :::
 
 **Trace Levels**

mission-control/docs/how-it-works.mdx

@@ -36,8 +36,8 @@ Mission Control uses Kubernetes Custom Resources Definitions as the underlying c
 | <a href="/config-db"><div class="flex flex-row"><Icon name="k8s-customresourcedefinition" size={22}/>ScrapeConfig</div> </a> | Configures scrapers to run periodically               | Config items, analysis, change, cost |
 | <a href="/canary-checker"><Icon  name="k8s-customresourcedefinition">Canary</Icon> </a>            | Runs health checks using HTTP, SQL, S3, kubectl, etc. | 1 or more checks (Health)            |
 | <a href="/notifications"><Icon name="k8s-customresourcedefinition">Notification</Icon>  </a>      | Sends notifications based on events                   | Email, Slack, etc                    |
-| <a href="/playbooks"><Icon  name="k8s-customresourcedefinition">Playbook</Icon>  </a>              | Defines playbooks that can be run on config items, health checks and componets                              | Pull Request, CLI,  Webhook          |
- <a href="/reference/connections"><Icon  name="k8s-customresourcedefinition">Connection</Icon>   </a>                | Re-usable connections with secure external lookup to Kuebrnetes secrets, configmaps, service accounts and Helm values | URL, username, password, etc        |
+| <a href="/playbooks"><Icon  name="k8s-customresourcedefinition">Playbook</Icon>  </a>              | Defines playbooks that can be run on config items, health checks and components                              | Pull Request, CLI,  Webhook          |
+ <a href="/reference/connections"><Icon  name="k8s-customresourcedefinition">Connection</Icon>   </a>                | Re-usable connections with secure external lookup to Kubernetes secrets, configmaps, service accounts and Helm values | URL, username, password, etc        |
   <a href="/topology"><Icon name="k8s-customresourcedefinition">Topology</Icon>  </a>           | Combines configs, health checks and lookups to form cards  | Component       |
 
 

mission-control/docs/notifications/channels/matrix.mdx

@@ -1,7 +1,7 @@
 # Matrix
 
 :::note Usage of the `title` parameter
     Do note that Matrix will discard any information put in the `title` parameter as the service has no analogue to a
     a title. Instead, use a custom message format to supply your wanted title as part of the message.
 :::
 
@@ -21,24 +21,24 @@
 
 ## Rooms
 
 If `rooms` are *not* specified, the service will send the message to all the rooms that the user has currently joined.
 
 Otherwise, the service will only send the message to the specified rooms. If the user is *not* in any of those rooms,
 but have been invited to it, it will automatically accept that invite.
 
 **Note**: The service will **not** join any rooms unless they are explicitly specified in `rooms`. If you need the user
 to join those rooms, you can send a notification with `rooms` explicitly set once.
 
 ### Room Lookup
 
 Rooms specified in `rooms` will be treated as room IDs if the start with a `!` and used directly to identify rooms. If
 they have no such prefix (or use a *correctly escaped* `#`) they will instead be treated as aliases, and a directory
 lookup will be used to resolve their corresponding IDs.
 
 **Note**: Don't use unescaped `#` for the channel aliases as that will be treated as the `fragment` part of the URL.
 Either omit them or URL encode them, I.E. `rooms=%23alias:server` or `rooms=alias:server`
 
 ### TLS
 
 If you do not have TLS enabled on the server you can disable it by providing `disableTLS=yes`. This will effectively
-use `http` intead of `https` for the API calls.
+use `http` instead of `https` for the API calls.

styles/Flanksource/ProfanityUnlikely.yml

@@ -66,7 +66,6 @@ tokens:
   - cocktail
   - coconut
   - coconuts
-  - color
   - colored
   - coloured
   - communist

styles/ignore/words-with-suggestions.txt

@@ -343,3 +343,36 @@ unencrypted
 etcd
 Bitnami
 imcp
+argocd
+fluxcd
+kustomize
+Kustomization
+originAnnotations
+Gitea
+flanksource
+AIOps
+oneOf
+API's
+clientHost
+fromName
+starttls
+shoutrrr
+botmail
+botkey
+parseMode
+botfather
+kustomization
+kustomizations
+hardcoded
+gitops
+cel
+mysql
+templatedBody
+workflow_dispatch
+buildMetadata
+getAction
+maxLength
+declaratively
+CEL's
+dependabot
+unescaped