Skip to content

Commit 6905c9e

Browse files
committed
Improving readability and tone by removing condescending phrases
1 parent af71c92 commit 6905c9e

File tree

21 files changed

+24
-24
lines changed

21 files changed

+24
-24
lines changed

content/en/docs/collector/building/connector.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ following links:
6464

6565
For this tutorial, we will write an example connector that takes traces and
6666
converts them into metrics as a basic example of how the connector component in
67-
OpenTelemetry functions. The functionality of the basic connector is to simply
67+
OpenTelemetry functions. The functionality of the basic connector is to
6868
count the number of spans in traces that contain a specific attribute name. The
6969
count of these occurrences are stored in the connector.
7070

content/en/docs/collector/building/receiver.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ this:
7575
In order to properly test your trace receiver, you may need a distributed
7676
tracing backend so the Collector can send the telemetry to it. We will be using
7777
[Jaeger](https://www.jaegertracing.io/docs/latest/getting-started/), if you
78-
don't have a `Jaeger` instance running, you can easily start one using Docker
78+
don't have a `Jaeger` instance running, you can start one using Docker
7979
with the following command:
8080

8181
```sh

content/en/docs/collector/custom-collector.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ Here are the tags for the `dist` map:
111111
As you can see on the table above, all the `dist` tags are optional, so you will
112112
be adding custom values for them depending if your intentions to make your
113113
custom Collector distribution available for consumption by other users or if you
114-
are simply leveraging the `ocb` to bootstrap your component development and
114+
are leveraging the `ocb` to bootstrap your component development and
115115
testing environment.
116116

117117
For this tutorial, you will be creating a Collector's distribution to support
@@ -214,7 +214,7 @@ The folder structure should look like this:
214214
```
215215

216216
You can now use the generated code to bootstrap your component development
217-
projects and easily build and distribute your own collector distribution with
217+
projects and build and distribute your own collector distribution with
218218
your components.
219219

220220
Further reading:

content/en/docs/collector/internal-telemetry.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ journalctl | grep otelcol | grep Error
136136

137137
## Types of internal telemetry
138138

139-
The OpenTelemetry Collector aims to be a model of observable service by clearly
139+
The OpenTelemetry Collector aims to be a model of observable service by
140140
exposing its own operational metrics. Additionally, it collects host resource
141141
metrics that can help you understand if problems are caused by a different
142142
process on the same host. Specific components of the Collector can also emit

content/en/docs/collector/management.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -82,11 +82,11 @@ Let's have a look at a concrete setup:
8282
the server-side OpAMP part and the collector (or a supervisor controlling the
8383
collector) implementing OpAMP client-side.
8484

85-
You can try out a simple OpAMP setup yourself by using the [OpAMP protocol
85+
You can try out an OpAMP setup yourself by using the [OpAMP protocol
8686
implementation in Go][opamp-go]. For the following walkthrough you will need to
8787
have Go in version 1.19 or above available.
8888

89-
We will set up a simple OpAMP control plane consisting of an example OpAMP
89+
We set up an OpAMP control plane consisting of an example OpAMP
9090
server and let an OpenTelemetry Collector connect to it via an example OpAMP
9191
supervisor.
9292

content/en/docs/collector/scaling.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ spec:
229229
Some receivers are actively obtaining telemetry data to place in the pipeline,
230230
like the hostmetrics and prometheus receivers. While getting host metrics isn’t
231231
something we’d typically scale up, we might need to split the job of scraping
232-
thousands of endpoints for the Prometheus receiver. And we can’t simply add more
232+
thousands of endpoints for the Prometheus receiver. And we can’t add more
233233
instances with the same configuration, as each Collector would try to scrape the
234234
same endpoints as every other Collector in the cluster, causing even more
235235
problems, like out-of-order samples.

content/en/docs/concepts/observability-primer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ cSpell:ignore: webshop
99

1010
Observability lets you understand a system from the outside by letting you ask
1111
questions about that system without knowing its inner workings. Furthermore, it
12-
allows you to easily troubleshoot and handle novel problems, that is, "unknown
12+
allows you to troubleshoot and handle novel problems, that is, "unknown
1313
unknowns”. It also helps you answer the question "Why is this happening?"
1414

1515
To ask those questions about your system, your application must be properly

content/en/docs/concepts/signals/traces.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -282,7 +282,7 @@ meaningful, singular point in time.
282282
#### When to use span events versus span attributes
283283

284284
Since span events also contain attributes, the question of when to use events
285-
instead of attributes might not always have an obvious answer. To inform your
285+
instead of attributes might not always have a clear answer. To inform your
286286
decision, consider whether a specific timestamp is meaningful.
287287

288288
For example, when you're tracking an operation with a span and the operation

content/en/docs/demo/collector-data-flow-dashboard/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ the data flow.
9797

9898
### Export Ratio
9999

100-
Export ratio is basically the ratio between receiver and exporter metrics. You
100+
Export ratio is the ratio between receiver and exporter metrics. You
101101
can notice over the dashboard screenshot above that the export ratio on metrics
102102
is way too high than the received metrics. This is because the demo application
103103
is configured to generate span metrics which is a processor that generates

content/en/docs/demo/requirements/architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ customization by end-users, vendors, and other stakeholders.
2424
- Provide developers with a robust sample application they can use in learning
2525
OpenTelemetry instrumentation.
2626
- Provide observability vendors with a single, well-supported, demo platform
27-
that they can further customize (or simply use OOB).
27+
that they can further customize (or use OOB).
2828
- Provide the OpenTelemetry community with a living artifact that demonstrates
2929
the features and capabilities of OTel APIs, SDKs, and tools.
3030
- Provide OpenTelemetry maintainers and WGs a platform to demonstrate new

content/en/docs/kubernetes/collector/components.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ Kubernetes-specific receiver, it is still the de facto solution for collecting
267267
any logs from Kubernetes.
268268

269269
The Filelog Receiver is composed of Operators that are chained together to
270-
process a log. Each Operator performs a simple responsibility, such as parsing a
270+
process a log. Each Operator performs a responsibility, such as parsing a
271271
timestamp or JSON. Configuring a Filelog Receiver is not trivial. If you're
272272
using the [OpenTelemetry Collector Helm chart](../../helm/collector/) you can
273273
use the [`logsCollection` preset](../../helm/collector/#logs-collection-preset)

content/en/docs/kubernetes/helm/demo.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The [OpenTelemetry Demo](/docs/demo/) is a microservice-based distributed system
77
intended to illustrate the implementation of OpenTelemetry in a near real-world
88
environment. As part of that effort, the OpenTelemetry community create the
99
[OpenTelemetry Demo Helm Chart](https://github.com/open-telemetry/opentelemetry-helm-charts/tree/main/charts/opentelemetry-demo)
10-
so that it can be easily installed in Kubernetes.
10+
so that it can be installed in Kubernetes.
1111

1212
## Configuration
1313

content/en/docs/languages/cpp/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ weight: 10
77

88
This page will show you how to get started with OpenTelemetry in C++.
99

10-
You will learn how to instrument a simple C++ application, such that
10+
You learn how to instrument a C++ application, such that
1111
[traces](/docs/concepts/signals/traces/) are emitted to the terminal.
1212

1313
## Prerequisites

content/en/docs/languages/go/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@ mutex.Unlock()
210210
```
211211

212212
A useful characteristic of events is that their timestamps are displayed as
213-
offsets from the beginning of the span, allowing you to easily see how much time
213+
offsets from the beginning of the span, allowing you to see how much time
214214
elapsed between them.
215215

216216
Events can also have attributes of their own -

content/en/docs/languages/go/resources.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ provider := sdktrace.NewTracerProvider(
2626
Note the use of the `semconv` package to provide
2727
[conventional names](/docs/concepts/semantic-conventions/) for resource
2828
attributes. This helps ensure that consumers of telemetry produced with these
29-
semantic conventions can easily discover relevant attributes and understand
29+
semantic conventions can discover relevant attributes and understand
3030
their meaning.
3131

3232
Resources can also be detected automatically through `resource.Detector`

content/en/docs/languages/java/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ weight: 10
99

1010
This page will show you how to get started with OpenTelemetry in Java.
1111

12-
You will learn how you can instrument a simple Java application automatically,
12+
You learn how you can instrument a Java application automatically,
1313
in such a way that [traces][], [metrics][], and [logs][] are emitted to the
1414
console.
1515

content/en/docs/languages/js/getting-started/browser.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -252,5 +252,5 @@ registerInstrumentations({
252252

253253
## Meta Packages for Web
254254

255-
To leverage the most common instrumentations all in one you can simply use the
255+
To leverage the most common instrumentations all in one you can use the
256256
[OpenTelemetry Meta Packages for Web](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-web)

content/en/docs/languages/php/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ OpenTelemetry for PHP can be used to generate and export [traces][], [metrics][]
1010
and [logs][].
1111

1212
This page will show you how to get started with OpenTelemetry in PHP. We will
13-
create a simple "roll the dice" application, then apply both zero-code and code
13+
create a "roll the dice" application, then apply both zero-code and code
1414
based instrumentation to generate [traces][] and export them to the console. We
1515
will then emit some [logs][] which will also be sent to the console.
1616

content/en/docs/languages/python/getting-started.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ weight: 10
88

99
This page will show you how to get started with OpenTelemetry in Python.
1010

11-
You will learn how you can instrument a simple application automatically, in
11+
You learn how you can instrument an application automatically, in
1212
such a way that [traces][], [metrics][], and [logs][] are emitted to the
1313
console.
1414

@@ -292,7 +292,7 @@ following:
292292
Automatic instrumentation captures telemetry at the edges of your systems, such
293293
as inbound and outbound HTTP requests, but it doesn't capture what's going on in
294294
your application. For that you'll need to write some
295-
[manual instrumentation](../instrumentation/). Here's how you can easily link up
295+
[manual instrumentation](../instrumentation/). Here's how you can link up
296296
manual instrumentation with automatic instrumentation.
297297

298298
### Traces

content/en/docs/languages/ruby/instrumentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,7 +222,7 @@ end
222222
```
223223

224224
A useful characteristic of events is that their timestamps are displayed as
225-
offsets from the beginning of the span, allowing you to easily see how much time
225+
offsets from the beginning of the span, allowing you to see how much time
226226
elapsed between them.
227227

228228
Events can also have attributes of their own e.g.

content/en/docs/languages/rust/getting-started.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ weight: 10
66

77
This page will show you how to get started with OpenTelemetry in Rust.
88

9-
You will learn how you can instrument a simple Rust application, in such a way
9+
You learn how you can instrument a Rust application, in such a way
1010
that [traces][] are emitted to the console.
1111

1212
## Prerequisites

0 commit comments

Comments
 (0)