Add misspell to do basic spell validation in our docs

Makefile.core.mk

@@ -523,6 +523,7 @@ GITLEAKS ?= $(LOCALBIN)/gitleaks
 OPM ?= $(LOCALBIN)/opm
 ISTIOCTL ?= $(LOCALBIN)/istioctl
 RUNME ?= $(LOCALBIN)/runme
+MISSPELL ?= $(LOCALBIN)/misspell
 
 ## Tool Versions
 OPERATOR_SDK_VERSION ?= v1.39.2
@@ -534,6 +535,7 @@ OLM_VERSION ?= v0.31.0
 GITLEAKS_VERSION ?= v8.26.0
 ISTIOCTL_VERSION ?= 1.26.0
 RUNME_VERSION ?= 3.13.2
+MISSPELL_VERSION ?= v0.3.4
 
 # GENERATE_RELATED_IMAGES defines whether `spec.relatedImages` is going to be generated or not
 # To disable set flag to false
@@ -720,8 +722,19 @@ lint-watches: ## Checks if the operator watches all resource kinds present in He
 lint-secrets: gitleaks ## Checks whether any secrets are present in the repository.
 	@${GITLEAKS} detect --no-git --redact -v
 
+.PHONY: lint-spell ## Run spell checker on the documentation files. Skipping sailoperator.io.md file.
+lint-spell: misspell
+	@echo "Get misspell from $(LOCALBIN)"
+	@echo "Running misspell on the documentation files"
+	@find $(REPO_ROOT)/docs -type f \( \( -name "*.md" -o -name "*.asciidoc" \) ! -name "*sailoperator.io.md" \) \
+	| xargs $(LOCALBIN)/misspell -error -locale US
+
+.PHONY: misspell
+misspell: $(LOCALBIN) ## Download misspell to bin directory.
+	@test -s $(LOCALBIN)/misspell || GOBIN=$(LOCALBIN) go install github.com/client9/misspell/cmd/misspell@$(MISSPELL_VERSION)
+
 .PHONY: lint
-lint: lint-scripts lint-licenses lint-copyright-banner lint-go lint-yaml lint-helm lint-bundle lint-watches lint-secrets ## Run all linters.
+lint: lint-scripts lint-licenses lint-copyright-banner lint-go lint-yaml lint-helm lint-bundle lint-watches lint-secrets lint-spell ## Run all linters.
 
 .PHONY: format
 format: format-go tidy-go ## Auto-format all code. This should be run before sending a PR.

docs/README.md

@@ -2297,7 +2297,7 @@ kubectl wait -n bookinfo --for=condition=programmed gtw bookinfo-gateway
 
 ### Generate traffic and visualize your mesh
 
-Send traffic to the productpage service. Note that this command will run until cancelled.
+Send traffic to the productpage service. Note that this command will run until canceled.
 
 ```bash
 export INGRESS_HOST=$(kubectl get gtw bookinfo-gateway -n bookinfo -o jsonpath='{.status.addresses[0].value}')

docs/common/istio-ambient-waypoint.md

@@ -62,7 +62,7 @@ kubectl label ns bookinfo istio.io/use-waypoint=waypoint
 
 After a namespace is enrolled to use a waypoint, any requests from any pods using the ambient data plane mode, to any service running in the `bookinfo` namespace, will be routed through the waypoint for L7 processing and policy enforcement. 
 
-If you prefer more granularity than using a waypoint for an entire namespace, you can enroll only a specific service or pod to use a waypoint by labelling the respective service or the pod. When enrolling a pod explicitly, you must also add the `istio.io/waypoint-for: workload` label to the Gateway resource.
+If you prefer more granularity than using a waypoint for an entire namespace, you can enroll only a specific service or pod to use a waypoint by labeling the respective service or the pod. When enrolling a pod explicitly, you must also add the `istio.io/waypoint-for: workload` label to the Gateway resource.
 #### Cross-namespace Waypoint
 
 By default, a waypoint is usable only within the same namespace, but it also supports cross-namespace usage. The following Gateway allows resources in the `bookinfo` namespace to use `waypoint-foo` from the `foo` namespace:

docs/guidelines/guidelines.md

@@ -63,7 +63,7 @@ The script `update-docs-examples.sh` is going to run the following steps:
 To add a new topic to the automation workflow you need to:
 1. In your documentation topic, each bash code block that you want to execute as part of the automation must include the following pattern:
 - `bash { name=example-name tag=example-tag }`: the fields used here are:
-  - `name`: the name of the example step, this is usefull to identify the step in the output of the test. The name should be short and descriptive. For example: `deploy-operator`, `wait-operator`, etc.
+  - `name`: the name of the example step, this is useful to identify the step in the output of the test. The name should be short and descriptive. For example: `deploy-operator`, `wait-operator`, etc.
   - `tag`: the tag of the example that is going to be used to run the test, is important to be a unique name. This tag should be unique and should not be used in other examples. The tag can be used to run only a specific example inside a file.
 For example:
 

tests/documentation_tests/README-runme.md

@@ -2297,7 +2297,7 @@ kubectl wait -n bookinfo --for=condition=programmed gtw bookinfo-gateway
 
 ### Generate traffic and visualize your mesh
 
-Send traffic to the productpage service. Note that this command will run until cancelled.
+Send traffic to the productpage service. Note that this command will run until canceled.
 
 ```bash
 export INGRESS_HOST=$(kubectl get gtw bookinfo-gateway -n bookinfo -o jsonpath='{.status.addresses[0].value}')

tools/update_deps.sh

@@ -90,5 +90,9 @@ RUNME_LATEST_VERSION=$(getLatestVersion runmedev/runme)
 RUNME_LATEST_VERSION=${RUNME_LATEST_VERSION#v}
 sed -i "s|RUNME_VERSION ?= .*|RUNME_VERSION ?= ${RUNME_LATEST_VERSION}|" "${ROOTDIR}/Makefile.core.mk"
 
+# Update misspell
+MISSPELL_LATEST_VERSION=$(getLatestVersion client9/misspell)
+sed -i "s|MISSPELL_VERSION ?= .*|MISSPELL_VERSION ?= ${MISSPELL_LATEST_VERSION}|" "${ROOTDIR}/Makefile.core.mk"
+
 # Regenerate files
 make update-istio gen