Skip to content

Commit 99dad40

Browse files
authored
cSpell fixes for some pages (operator, faas, acknowledgement, opencensus, what is otel) (open-telemetry#2934)
1 parent 2fb34dc commit 99dad40

File tree

7 files changed

+22
-17
lines changed

7 files changed

+22
-17
lines changed

content/en/blog/2023/end-user-q-and-a-03.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ others are still instrumented using the [legacy OpenTracing
157157
The OpenTelemetry Operator is being implemented to auto-instrument Java and .NET
158158
code. Among other things, the [OTel Operator](/docs/k8s-operator/) supports
159159
injecting and
160-
[configuring auto-instrumentation](/docs/k8s-operator/automatic/#configure-autoinstrumentation)
160+
[configuring auto-instrumentation](/docs/k8s-operator/automatic/#configure-automatic-instrumentation)
161161
in .NET, Java, Python, and Node.js. Iris hopes that Go auto-instrumentation will
162162
be available in the near-future. To track progress of auto-instrumentation in
163163
Go, see

content/en/docs/acknowledgements/_index.md

+1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ description: Acknowledgements for sources for content on this site
44
spelling: cSpell:ignore otel
55
aliases: [/acknowledgements]
66
weight: 200
7+
spelling: cSpell:ignore Pigram
78
---
89

910
We would like to acknowledge the following sources for some of the content on

content/en/docs/faas/lambda-auto-instrument.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Lambda Auto-Instrumentation
33
weight: 11
44
description: Automatically instrument your Lambdas with OpenTelemetry
5+
spelling: cSpell:ignore Corretto regionalized
56
---
67

78
The OpenTelemetry community provides standalone instrumentation Lambda layers
@@ -80,7 +81,7 @@ about supported JavaScript and Node.js versions, see the
8081

8182
The Lambda layer supports Python 3.8 and Python 3.9 Lambda runtimes. For more
8283
information about supported Python versions, see the
83-
[OpenTelemetry Python documentation](https://github.com/open-telemetry/opentelemetry-python/blob/master/README.md#supported-runtimes)
84+
[OpenTelemetry Python documentation](https://github.com/open-telemetry/opentelemetry-python/blob/main/README.md#supported-runtimes)
8485
and the package on [PyPi](https://pypi.org/project/opentelemetry-api/).
8586

8687
<!-- prettier-ignore -->

content/en/docs/faas/lambda-collector.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Lambda Collector Configuration
33
linkTitle: Lambda Collector Config
44
weight: 11
55
description: Add and configure the Collector Lambda layer to your Lambda
6+
spelling: cSpell:ignore ADOT regionalized confmap loglevel awsxray configmap
67
---
78

89
The OpenTelemetry community offers the Collector in a separate Lambda layer from

content/en/docs/k8s-operator/automatic.md

+15-14
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ linkTitle: Auto-instrumentation
44
weight: 11
55
description:
66
An implementation of auto-instrumentation using the OpenTelemetry Operator.
7-
spelling: cSpell:ignore Otel
7+
spelling:
8+
cSpell:ignore otlpreceiver k8sattributesprocessor GRPCNETCLIENT REDISCALA
89
---
910

1011
The OpenTelemetry Operator supports injecting and configuring
@@ -95,11 +96,11 @@ EOF
9596
The above command results in a deployment of the Collector that you can use as
9697
an endpoint for auto-instrumentation in your pods.
9798

98-
## Configure Autoinstrumentation
99+
## Configure Automatic Instrumentation
99100

100-
To be able to manage autoinstrumentation, the Operator needs to be configured to
101-
know what pods to instrument and which autoinstrumentation to use for those
102-
pods. This is done via the
101+
To be able to manage automatic instrumentation, the Operator needs to be
102+
configured to know what pods to instrument and which automatic instrumentation
103+
to use for those pods. This is done via the
103104
[Instrumentation CRD](https://github.com/open-telemetry/opentelemetry-operator/blob/main/docs/api.md#instrumentation).
104105

105106
Creating the Instrumentation resource correctly is paramount to getting
@@ -133,7 +134,7 @@ By default, the Instrumentation resource that auto-instruments .NET services
133134
uses `otlp` with the `http/protobuf` protocol. This means that the configured
134135
endpoint must be able to receive OTLP over `http/protobuf`. Therefore, the
135136
example uses `http://demo-collector:4318`, which will connect to the `http` port
136-
of the otlpreceiver of the Collector created in the previous step.
137+
of the `otlpreceiver` of the Collector created in the previous step.
137138

138139
By default, the .NET auto-instrumentation ships with
139140
[many instrumentation libraries](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docs/config.md#instrumentations).
@@ -261,7 +262,7 @@ By default, the Instrumentation resource that auto-instruments Node.js services
261262
uses `otlp` with the `grpc` protocol. This means that the configured endpoint
262263
must be able to receive OTLP over `grpc`. Therefore, the example uses
263264
`http://demo-collector:4317`, which connects to the `grpc` port of the
264-
otlpreceiver of the Collector created in the previous step.
265+
`otlpreceiver` of the Collector created in the previous step.
265266

266267
By default, the Node.js auto-instrumentation ships with
267268
[many instrumentation libraries](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/metapackages/auto-instrumentations-node/README.md#supported-instrumentations).
@@ -300,7 +301,7 @@ By default, the Instrumentation resource that auto-instruments python services
300301
uses `otlp` with the `http/protobuf` protocol. This means that the configured
301302
endpoint must be able to receive OTLP over `http/protobuf`. Therefore, the
302303
example uses `http://demo-collector:4318`, which will connect to the `http` port
303-
of the otlpreceiver of the Collector created in the previous step.
304+
of the `otlpreceiver` of the Collector created in the previous step.
304305

305306
> As of operator v0.67.0, the Instrumentation resource automatically sets
306307
> `OTEL_EXPORTER_OTLP_TRACES_PROTOCOL` and `OTEL_EXPORTER_OTLP_METRICS_PROTOCOL`
@@ -343,14 +344,14 @@ spec:
343344
Now that your Instrumentation object is created, your cluster has the ability to
344345
auto-instrument services and send data to an endpoint. However,
345346
auto-instrumentation with the OpenTelemetry Operator follows an opt-in model. In
346-
order to activate autoinstrumentation, you'll need to add an annotation to your
347-
deployment.
347+
order to activate automatic instrumentation, you'll need to add an annotation to
348+
your deployment.
348349
349350
## Add annotations to existing deployments
350351
351-
The final step is to opt in your services to autoinstrumentation. This is done
352-
by updating your service’s `spec.template.metadata.annotations` to include a
353-
language-specific annotation:
352+
The final step is to opt in your services to automatic instrumentation. This is
353+
done by updating your service’s `spec.template.metadata.annotations` to include
354+
a language-specific annotation:
354355

355356
- .NET: `instrumentation.opentelemetry.io/inject-dotnet: "true"`
356357
- Java: `instrumentation.opentelemetry.io/inject-java: "true"`
@@ -369,6 +370,6 @@ The possible values for the annotation can be
369370
- `"false"` - do not inject
370371

371372
Alternatively, the annotation can be added to a namespace, which will result in
372-
all services in that namespace to opt-in to autoinstrumentation. See the
373+
all services in that namespace to opt-in to automatic instrumentation. See the
373374
[Operators auto-instrumentation documentation](https://github.com/open-telemetry/opentelemetry-operator/blob/main/README.md#opentelemetry-auto-instrumentation-injection)
374375
for more details.

content/en/docs/migration/opencensus.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,6 @@ title: Migrating from OpenCensus
33
linkTitle: OpenCensus
44
redirect: /blog/2023/sunsetting-opencensus/#how-to-migrate-to-opentelemetry
55
_build: { render: link }
6+
spelling: cSpell:ignore sunsetting
67
weight: 3
78
---

content/en/docs/what-is-opentelemetry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ combine their strengths and truly offer a single standard.
101101
## What OpenTelemetry is not
102102

103103
OpenTelemetry is not an observability back-end like Jaeger, Prometheus, or
104-
commerical vendors. OpenTelemetry is focused on the generation, collection,
104+
commercial vendors. OpenTelemetry is focused on the generation, collection,
105105
management, and export of telemetry data. The storage and visualization of that
106106
data is intentionally left to other tools.
107107

0 commit comments

Comments
 (0)