diff --git a/.typos.toml b/.typos.toml index 2783c51..730f722 100644 --- a/.typos.toml +++ b/.typos.toml @@ -1,10 +1,16 @@ [default] locale = "en-au" -extend-ignore-words-re = ["Ded"] +[default.extend-identifiers] +center = "center" # Due to CSS usage +authorization = "authorization" # due to rbac.authorization.k8s.io usage [files] ignore-vcs = true extend-exclude = [ ".git", + "LICENSE", + "*policyreports*.yaml", + "clusterpolicyreports.yaml" ] + diff --git a/docs/README.md b/docs/README.md index dc3e9b5..dcf9889 100644 --- a/docs/README.md +++ b/docs/README.md @@ -19,7 +19,7 @@ npm run dev Finally, open [http://localhost:3000](http://localhost:3000) in your browser to view the website. -## Customizing +## Customising You can start editing this template by modifying the files in the `/src` folder. The site will auto-update as you edit these files. diff --git a/docs/src/pages/docs/alerting.md b/docs/src/pages/docs/alerting.md index 45b200a..dfdfe75 100644 --- a/docs/src/pages/docs/alerting.md +++ b/docs/src/pages/docs/alerting.md @@ -51,7 +51,7 @@ policy reports a failure status. The alert includes details about the failing po ## Configure Alerting in Grafana -Grafana can visualize the alerts generated by Prometheus and also send notifications through various channels such as email, Slack, or PagerDuty. Grafana alert can be configured manually via the UI, or via a configuration file. +Grafana can visualise the alerts generated by Prometheus and also send notifications through various channels such as email, Slack, or PagerDuty. Grafana alert can be configured manually via the UI, or via a configuration file. ### Configure Alerting via UI diff --git a/docs/src/pages/index.md b/docs/src/pages/index.md index ec8a084..efa3d98 100644 --- a/docs/src/pages/index.md +++ b/docs/src/pages/index.md @@ -87,7 +87,7 @@ The `PolicyReport` contains information about the test run and the results of th {% quick-link title="Architecture guide" icon="presets" href="/" description="Learn how the internals work and contribute." /%} -{% quick-link title="API reference" icon="theming" href="/" description="Learn to easily customize and modify your app's visual design to fit your brand." /%} +{% quick-link title="API reference" icon="theming" href="/" description="Learn to easily customise and modify your app's visual design to fit your brand." /%} {% quick-link title="Examples" icon="plugins" href="/" description="See how others are using the library in their projects." /%} diff --git a/operator/netchecks_operator/main.py b/operator/netchecks_operator/main.py index c2842cd..c33e703 100644 --- a/operator/netchecks_operator/main.py +++ b/operator/netchecks_operator/main.py @@ -53,7 +53,7 @@ API_GROUP_NAME = "netchecks.io" -# Initialize metrics +# Initialise metrics metrics.set_meter_provider(MeterProvider(metric_readers=[PrometheusMetricReader()])) meter = metrics.get_meter("netchecks-operator", version=NETCHECK_OPERATOR_VERSION) @@ -407,12 +407,12 @@ def monitor_selected_netcheck_pods(name, namespace, spec, status, stopped, **kwa logger.info("Pod monitoring complete", name=name, namespace=namespace) -def summarize_results(probe_results): +def summarise_results(probe_results): """ - Summarize the results of the probe run + Summarise the results of the probe run """ logger = get_logger() - logger.debug("Summarizing probe results") + logger.debug("Summarising probe results") logger.debug("Current probe results", probe_results=probe_results) # Dict of pass/fail/warn/error counts defaulting to 0 summary = defaultdict(int) @@ -490,7 +490,7 @@ def upsert_policy_report(probe_results, assertion_name, namespace, pod_name): labels = get_common_labels(name=assertion_name) labels["policy.kubernetes.io/engine"] = "netcheck" report_results = convert_results_for_policy_report(probe_results, logger) - report_summary = summarize_results(probe_results) + report_summary = summarise_results(probe_results) logger.debug("Probe Summary", data=report_summary) policy_report_body = { "apiVersion": "wgpolicyk8s.io/v1alpha2",