Add Spell Checker to CI (#668)

## Which problem is this PR solving? - Closes [#665](#665) ## Description of the changes - Simply added a new cspell job to the existing ci-test workflow. - Will perform the spell check in the content directory and its subdirectories. - Added the same set of dictionary as suggested in the reference PR in the issue thread. (Let me know if any more words need to be added) --------- Signed-off-by: Ashutosh Srivastava <[email protected]> Signed-off-by: Yuri Shkuro <[email protected]> Signed-off-by: Yuri Shkuro <[email protected]> Co-authored-by: Yuri Shkuro <[email protected]> Co-authored-by: Yuri Shkuro <[email protected]>
jaegertracing · Apr 4, 2024 · 916ed3a · 916ed3a
1 parent c2ac9fa
commit 916ed3a
Show file tree

Hide file tree

Showing 57 changed files with 1,505 additions and 60 deletions.
diff --git a/.github/workflows/ci-test.yml b/.github/workflows/ci-test.yml
@@ -26,6 +26,10 @@ jobs:
         sudo mv hugo /usr/local/bin
         hugo version
 
+    - name: Spellcheck
+      run: |
+        make spellcheck
+
     - name: Build
       run: |
         make build
diff --git a/Makefile b/Makefile
@@ -55,6 +55,9 @@ check-internal-links: clean build link-checker-setup run-link-checker
 check-all-links: clean build link-checker-setup
 	bin/htmltest --conf .htmltest.external.yml
 
+spellcheck:
+	cd scripts/cspell && ./spellcheck.sh
+
 # only x.y.0 semver values are valid for kicking off a new release.
 SEMVER_REGEX := ^([0-9]+\.){2}0$$
 VALID_VERSION := $(shell echo "$(VERSION)" | grep -E "$(SEMVER_REGEX)")

diff --git a/content/_client_libs/client-libraries.md b/content/_client_libs/client-libraries.md
@@ -32,7 +32,7 @@ OpenTelemetry implements baggage propagation differently from OpenTracing and th
 
 #### We need your help!
 
-If you find inaccuracies or have information that can be added, please open an issue or a PR to the [documentation repo](https://github.com/jaegertracing/documentation). If some features are missing and you need them, please open tickets in the respective OpenTelemetry repos or contibute. For example, Jaeger's remote samplers are not yet implemented in every OpenTelemetry SDK, but porting them from the Jaeger codebase is a fairly straightforward task.
+If you find inaccuracies or have information that can be added, please open an issue or a PR to the [documentation repo](https://github.com/jaegertracing/documentation). If some features are missing and you need them, please open tickets in the respective OpenTelemetry repos or contribute. For example, Jaeger's remote samplers are not yet implemented in every OpenTelemetry SDK, but porting them from the Jaeger codebase is a fairly straightforward task.
 
 #### Copying Jaeger code
 

diff --git a/content/docs/1.28/deployment.md b/content/docs/1.28/deployment.md
@@ -297,7 +297,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.29/deployment.md b/content/docs/1.29/deployment.md
@@ -317,7 +317,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.30/deployment.md b/content/docs/1.30/deployment.md
@@ -317,7 +317,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.31/deployment.md b/content/docs/1.31/deployment.md
@@ -317,7 +317,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.32/deployment.md b/content/docs/1.32/deployment.md
@@ -317,7 +317,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.33/deployment.md b/content/docs/1.33/deployment.md
@@ -320,7 +320,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.34/deployment.md b/content/docs/1.34/deployment.md
@@ -320,7 +320,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.35/deployment.md b/content/docs/1.35/deployment.md
@@ -320,7 +320,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.36/deployment.md b/content/docs/1.36/deployment.md
@@ -320,7 +320,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.37/deployment.md b/content/docs/1.37/deployment.md
@@ -398,7 +398,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.38/deployment.md b/content/docs/1.38/deployment.md
@@ -398,7 +398,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.39/deployment.md b/content/docs/1.39/deployment.md
@@ -398,7 +398,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.40/deployment.md b/content/docs/1.40/deployment.md
@@ -398,7 +398,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.41/deployment.md b/content/docs/1.41/deployment.md
@@ -398,7 +398,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.42/deployment.md b/content/docs/1.42/deployment.md
@@ -398,7 +398,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.43/deployment.md b/content/docs/1.43/deployment.md
@@ -403,7 +403,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.44/deployment.md b/content/docs/1.44/deployment.md
@@ -403,7 +403,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.45/deployment.md b/content/docs/1.45/deployment.md
@@ -403,7 +403,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.46/deployment.md b/content/docs/1.46/deployment.md
@@ -403,7 +403,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.47/deployment.md b/content/docs/1.47/deployment.md
@@ -403,7 +403,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.48/deployment.md b/content/docs/1.48/deployment.md
@@ -403,7 +403,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.49/architecture.md b/content/docs/1.49/architecture.md
@@ -107,7 +107,7 @@ The instrumentation is designed to be always on in production. To minimize the o
 ### Agent
 
 {{< warning >}}
-**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equiped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
+**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equipped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
 {{< /warning >}}
 
 **jaeger-agent** is a network daemon that listens for spans sent over UDP, which are batched and sent to the collector. It is designed to be deployed to all hosts as an infrastructure component. The agent abstracts the routing and discovery of the collectors away from the client. **jaeger-agent** is **not** a required component.

diff --git a/content/docs/1.49/deployment.md b/content/docs/1.49/deployment.md
@@ -97,7 +97,7 @@ You can navigate to `http://localhost:16686` to access the Jaeger UI.
 ## Agent
 
 {{< warning >}}
-**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equiped with OTLP exporters) directly to **jaeger-collector**. See the [Architecture](../architecture) page for alternative deployment options.
+**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equipped with OTLP exporters) directly to **jaeger-collector**. See the [Architecture](../architecture) page for alternative deployment options.
 {{< /warning >}}
 
 **jaeger-agent** is designed to receive tracing data in Thrift format over UDP and run locally on each host, either as a host agent / daemon or as an application sidecar. **jaeger-agent** exposes the following ports:
@@ -403,7 +403,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.50/architecture.md b/content/docs/1.50/architecture.md
@@ -107,7 +107,7 @@ The instrumentation is designed to be always on in production. To minimize the o
 ### Agent
 
 {{< warning >}}
-**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equiped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
+**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equipped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
 {{< /warning >}}
 
 **jaeger-agent** is a network daemon that listens for spans sent over UDP, which are batched and sent to the collector. It is designed to be deployed to all hosts as an infrastructure component. The agent abstracts the routing and discovery of the collectors away from the client. **jaeger-agent** is **not** a required component.

diff --git a/content/docs/1.50/deployment.md b/content/docs/1.50/deployment.md
@@ -97,7 +97,7 @@ You can navigate to `http://localhost:16686` to access the Jaeger UI.
 ## Agent
 
 {{< warning >}}
-**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equiped with OTLP exporters) directly to **jaeger-collector**. See the [Architecture](../architecture) page for alternative deployment options.
+**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equipped with OTLP exporters) directly to **jaeger-collector**. See the [Architecture](../architecture) page for alternative deployment options.
 {{< /warning >}}
 
 **jaeger-agent** is designed to receive tracing data in Thrift format over UDP and run locally on each host, either as a host agent / daemon or as an application sidecar. **jaeger-agent** exposes the following ports:
@@ -403,7 +403,7 @@ docker run \
   jaegertracing/jaeger-collector:{{< currentVersion >}}
 ```
 
-Note: White space characters are allowed in `CASSANDA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
+Note: White space characters are allowed in `CASSANDRA_SERVERS`. For Example: Servers can be passed as `CASSANDRA_SERVERS="1.2.3.4, 5.6.7.8" for better readability.
 
 ##### All options
 To view the full list of configuration options, you can run the following command:

diff --git a/content/docs/1.50/security.md b/content/docs/1.50/security.md
@@ -8,7 +8,7 @@ This page documents the existing security mechanisms in Jaeger, organized by the
 ## SDK to Agent
 
 {{< warning >}}
-**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equiped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
+**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equipped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
 {{< /warning >}}
 
 Deployments that involve **jaeger-agent** are meant for trusted environments where the agent is run as a sidecar within the container's network namespace, or as a host agent. Therefore, there is currently no support for traffic encryption between clients and agents.

diff --git a/content/docs/1.51/architecture.md b/content/docs/1.51/architecture.md
@@ -107,7 +107,7 @@ The instrumentation is designed to be always on in production. To minimize the o
 ### Agent
 
 {{< warning >}}
-**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equiped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
+**jaeger-agent** is [deprecated](https://github.com/jaegertracing/jaeger/issues/4739). The OpenTelemetry data can be sent from the OpenTelemetry SDKs (equipped with OTLP exporters) directly to **jaeger-collector**. Alternatively, use the OpenTelemetry Collector as a local agent.
 {{< /warning >}}
 
 **jaeger-agent** is a network daemon that listens for spans sent over UDP, which are batched and sent to the collector. It is designed to be deployed to all hosts as an infrastructure component. The agent abstracts the routing and discovery of the collectors away from the client. **jaeger-agent** is **not** a required component.