Skip to content

Commit

Permalink
Prepare markdownlint update
Browse files Browse the repository at this point in the history
Signed-off-by: svrnm <[email protected]>
  • Loading branch information
svrnm committed Nov 22, 2023
1 parent b219195 commit 898c688
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 25 deletions.
4 changes: 2 additions & 2 deletions content/en/community/end-user/discussion-group.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Feedback that is shared and collected in these sessions will be routed back to
the relevant project maintainers to help drive prioritization of improvements
and changes to the project.

**New for 2023!**
## New for 2023

- Sessions are now available for all regions!
- You can now find summaries of past discussions every month! Search the blog
Expand All @@ -26,7 +26,7 @@ and changes to the project.
recorded**. This will help make the feedback more discoverable by the
community.

**Upcoming sessions**
## Upcoming sessions

Here are upcoming sessions, or you can view them on the
[OpenTelemetry calendar](https://github.com/open-telemetry/community#calendar):
Expand Down
16 changes: 8 additions & 8 deletions content/en/docs/collector/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ Familiarity with the following pages is assumed:
The Collector consists of four components that access telemetry data:

- [Receivers](#receivers)
<img width="32" class="img-initial" src="/img/logos/32x32/Receivers.svg">
<img width="32" alt="" class="img-initial" src="/img/logos/32x32/Receivers.svg">
- [Processors](#processors)
<img width="32" class="img-initial" src="/img/logos/32x32/Processors.svg">
<img width="32" alt="" class="img-initial" src="/img/logos/32x32/Processors.svg">
- [Exporters](#exporters)
<img width="32" class="img-initial" src="/img/logos/32x32/Exporters.svg">
<img width="32" alt="" class="img-initial" src="/img/logos/32x32/Exporters.svg">
- [Connectors](#connectors)
<img width="32" class="img-initial" src="/img/logos/32x32/Load_Balancer.svg">
<img width="32" alt="" class="img-initial" src="/img/logos/32x32/Load_Balancer.svg">

These components once configured must be enabled via pipelines within the
[service](#service) section.
Expand Down Expand Up @@ -172,7 +172,7 @@ service:
exporters: [otlp]
```

## Receivers <img width="35" class="img-initial" src="/img/logos/32x32/Receivers.svg"> {#receivers}
## Receivers <img width="35" class="img-initial" alt="" src="/img/logos/32x32/Receivers.svg"> {#receivers}

A receiver, which can be push or pull based, is how data gets into the
Collector. Receivers may support one or more
Expand Down Expand Up @@ -247,7 +247,7 @@ receivers:
zipkin:
```

## Processors <img width="35" class="img-initial" src="/img/logos/32x32/Processors.svg"> {#processors}
## Processors <img width="35" class="img-initial" alt="" src="/img/logos/32x32/Processors.svg"> {#processors}

Processors are run on data between being received and being exported. Processors
are optional though
Expand Down Expand Up @@ -328,7 +328,7 @@ processors:
separator: '::'
```

## Exporters <img width="35" class="img-initial" src="/img/logos/32x32/Exporters.svg"> {#exporters}
## Exporters <img width="35" class="img-initial" alt="" src="/img/logos/32x32/Exporters.svg"> {#exporters}

An exporter, which can be push or pull based, is how you send data to one or
more backends/destinations. Exporters may support one or more
Expand Down Expand Up @@ -406,7 +406,7 @@ exporters:
endpoint: http://localhost:9411/api/v2/spans
```
## Connectors <img width="32" class="img-initial" src="/img/logos/32x32/Load_Balancer.svg"> {#connectors}
## Connectors <img width="32" class="img-initial" alt="" src="/img/logos/32x32/Load_Balancer.svg"> {#connectors}
A connector is both an exporter and receiver. As the name suggests a Connector
connects two pipelines: It consumes data as an exporter at the end of one
Expand Down
12 changes: 6 additions & 6 deletions content/en/docs/kubernetes/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ This instance of the collector will use the following components:

Let's break these down.

**OTLP Receiver**
### OTLP Receiver

The
[OTLP Receiver](https://github.com/open-telemetry/opentelemetry-collector/tree/main/receiver/otlpreceiver)
Expand All @@ -105,7 +105,7 @@ a node to emit their traces, metrics, and logs to a collector running on the
same node. This keeps network interactions simple and allows easy correlation of
Kubernetes metadata using the `k8sattributes` processor.

**Kubernetes Attributes Processor**
### Kubernetes Attributes Processor

The
[Kubernetes Attributes Processor](../collector/components/#kubernetes-attributes-processor)
Expand All @@ -117,7 +117,7 @@ Kubernetes context to your telemetry, the Kubernetes Attributes Processor lets
you correlate your application's traces, metrics, and logs signals with your
Kubernetes telemetry, such as pod metrics and traces.

**Kubeletstats Receiver**
### Kubeletstats Receiver

The [Kubeletstats Receiver](../collector/components/#kubeletstats-receiver) is
the receiver that gathers metrics about the node. It will gather metrics like
Expand All @@ -127,7 +127,7 @@ using the Kubernetes Attributes Processor, we'll be able to correlate our
application traces, metrics, and logs with the metrics produced by the
Kubeletstats Receiver.

**Filelog Receiver**
### Filelog Receiver

The [Filelog Receiver](../collector/components/#filelog-receiver) will collect
logs written to stdout/stderr by tailing the logs Kubernetes writes to
Expand Down Expand Up @@ -209,15 +209,15 @@ This instance of the Collector will use the following components:

Let's break these down.

**Kubernetes Cluster Receiver**
### Kubernetes Cluster Receiver

The
[Kubernetes Cluster Receiver](../collector/components/#kubernetes-cluster-receiver)
is the Collector's solution for collecting metrics about the state of the
cluster as a whole. This receiver can gather metrics about node conditions, pod
phases, container restarts, available and desired deployments, and more.

**Kubernetes Objects Receiver**
### Kubernetes Objects Receiver

The
[Kubernetes Objects Receiver](../collector/components/#kubernetes-objects-receiver)
Expand Down
18 changes: 9 additions & 9 deletions content/en/docs/kubernetes/operator/automatic.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ endpoint must be able to receive OTLP over `http/protobuf`. Therefore, the
example uses `http://demo-collector:4318`, which will connect to the `http` port
of the `otlpreceiver` of the Collector created in the previous step.

**Excluding auto-instrumentation**
#### Excluding auto-instrumentation {#dotnet-excluding-auto-instrumentation}

By default, the .NET auto-instrumentation ships with
[many instrumentation libraries](https://github.com/open-telemetry/opentelemetry-dotnet-instrumentation/blob/main/docs/config.md#instrumentations).
Expand Down Expand Up @@ -174,7 +174,7 @@ spec:
value: false
```
**Learn more**
#### Learn more {#dotnet-learn-more}
For more details, see
[.NET Auto Instrumentation docs](/docs/instrumentation/net/automatic/).
Expand Down Expand Up @@ -208,7 +208,7 @@ must be able to receive OTLP over `grpc`. Therefore, the example uses
`http://demo-collector:4317`, which connects to the `grpc` port of the
otlpreceiver of the Collector created in the previous step.

**Excluding auto-instrumentation**
#### Excluding auto-instrumentation {#java-excluding-auto-instrumentation}

Check failure on line 211 in content/en/docs/kubernetes/operator/automatic.md

View workflow job for this annotation

GitHub Actions / TEXT linter

textlint terminology error

Incorrect usage of the term: “java”, use “Java” instead

By default, the Java auto-instrumentation ships with
[many instrumentation libraries](/docs/instrumentation/java/automatic/#supported-libraries-frameworks-application-services-and-jvms).
Expand Down Expand Up @@ -244,7 +244,7 @@ spec:
value: false
```
**Learn more**
#### Learn more {#java-learn-more}

Check failure on line 247 in content/en/docs/kubernetes/operator/automatic.md

View workflow job for this annotation

GitHub Actions / TEXT linter

textlint terminology error

Incorrect usage of the term: “java”, use “Java” instead
For more details, see
[Java agent Configuration](/docs/instrumentation/java/automatic/agent-config/).
Expand Down Expand Up @@ -278,7 +278,7 @@ must be able to receive OTLP over `grpc`. Therefore, the example uses
`http://demo-collector:4317`, which connects to the `grpc` port of the
`otlpreceiver` of the Collector created in the previous step.

**Excluding auto-instrumentation**
#### Excluding auto-instrumentation {#js-excluding-auto-instrumentation}

By default, the Node.js auto-instrumentation ships with
[many instrumentation libraries](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/metapackages/auto-instrumentations-node/README.md#supported-instrumentations).
Expand All @@ -287,7 +287,7 @@ specific packages. If you don't want to use a package included by the default
image you must either supply your own image that includes only the packages you
want or use manual instrumentation.

**Learn more**
#### Learn more {#js-learn-more}

For more details, see
[Node.js auto-instrumentation](/docs/instrumentation/js/libraries/#registration).
Expand Down Expand Up @@ -328,7 +328,7 @@ in the previous step.
> Operator you **MUST** set these env variables to `http/protobuf`, or Python
> auto-instrumentation will not work.
**Auto-instrumenting Python logs**
#### Auto-instrumenting Python logs

By default, Python logs auto-instrumentation is disabled. If you would like to
enable this feature, you must to set the `OTEL_LOGS_EXPORTER` and
Expand Down Expand Up @@ -359,7 +359,7 @@ spec:
> Note that `OTEL_LOGS_EXPORTER` must be explicitly set to `otlp_proto_http`,
> otherwise it defaults to gRPC.

**Excluding auto-instrumentation**
#### Excluding auto-instrumentation {#python-excluding-auto-instrumentation}

By default the Python auto-instrumentation will detect the packages in your
Python service and instrument anything it can. This makes instrumentation easy,
Expand Down Expand Up @@ -389,7 +389,7 @@ spec:
instrumentation>
```

**Learn more**
#### Learn more {#python-learn-more}

[See the Python agent Configuration docs for more details.](/docs/instrumentation/python/automatic/agent-config/#disabling-specific-instrumentations)

Expand Down

0 comments on commit 898c688

Please sign in to comment.