Skip to content

Commit

Permalink
[editorial] Add use of markdownlint-cli2 for linting, wrap some URLs …
Browse files Browse the repository at this point in the history
…in angle brackets (open-telemetry#6251)
  • Loading branch information
chalin authored Feb 10, 2025
1 parent b36607f commit 5472965
Show file tree
Hide file tree
Showing 37 changed files with 75 additions and 85 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -77,4 +77,4 @@ feedback!
_A version of this article was [originally posted][] on
[medium.com/opentelemetry](https://medium.com/opentelemetry)._

[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/auto-instrumentation-k8s.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ This article introduces OpenTelemetry Operator’s new feature that significantl
simplifies instrumenting workloads deployed on Kubernetes. Read all the details
from the [original post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/collector.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ canonical_url: https://medium.com/opentelemetry/opentelemetry-collector-achieves
The OpenTelemetry Collector has made its first GA release. For all the details,
see the [original post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ OpenTelemetry C++ released its v1.0 stable version last month, which implements
the OpenTelemetry distributed tracing specification! For all the details, see
the [original post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/gc-election.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ The OpenTelemetry project is excited to announce the 2021 OpenTelemetry
Governance Committee (GC) election. For all the details, see the [original
post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/malabi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ cSpell:ignore: Malabi
This article introduces you to Malabi, a new open source tool for trace-based
testing. For all the details, see the [original post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/otel-gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ canonical_url: https://medium.com/opentelemetry/welcome-to-the-incoming-2021-ope
The OpenTelemetry project just completed its 2021 election for the Governance
Committee (GC). For all the details, see the [original post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/python.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ canonical_url: https://medium.com/opentelemetry/announcing-opentelemetry-python-
Today, OpenTelemetry Python distributed tracing API/SDK released its 1.0
version. For all the details, see the [original post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/swift.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ canonical_url: https://medium.com/opentelemetry/opentelemetry-swift-1-0-beta-8f7
Today, OpenTelemetry Swift distributed tracing API/SDK has released its 1.0
version. For all the details, see the [original post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2021/womens-day.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,4 @@ Happy International Women’s Day! The OpenTelemetry project would like to exten
our thanks to all our women contributors. For all the details, see the [original
post][].

[original post]: {{% param canonical_url %}}
[original post]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2022/apisix/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -395,4 +395,4 @@ _A version of this article was [originally posted][] on the Apache APISIX blog._

[^1]: {{% param notes.docker-compose-v2 %}}

[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
3 changes: 1 addition & 2 deletions content/en/blog/2022/exponential-histograms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,8 +278,6 @@ documentation on [instrumentation][] or [github.com/open-telemetry][].

_A version of this article was [originally posted][] on the New Relic blog._

[originally posted]: {{% param canonical_url %}}

[api]: /docs/specs/otel/metrics/api/
[sdk]: /docs/specs/otel/metrics/sdk/
[meter provider]: /docs/specs/otel/metrics/api/#meterprovider
Expand All @@ -304,3 +302,4 @@ _A version of this article was [originally posted][] on the New Relic blog._
[environment variable]: /docs/specs/otel/metrics/sdk_exporters/otlp/
[instrumentation]: /docs/languages
[github.com/open-telemetry]: https://github.com/open-telemetry
[originally posted]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2022/go-web-app-instrumentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -415,4 +415,4 @@ find all files ready to use in our GitHub

_A version of this article was [originally posted][] on the Aspecto blog._

[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
4 changes: 2 additions & 2 deletions content/en/blog/2022/k8s-metadata/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ cSpell:ignore: k8sattributes k8sattributesprocessor k8sprocessor KUBE replicaset

{{% alert title="Note" color="info" %}} The most up to date information for how
to enhance telemetry with Kubernetes metadata can be found in the docs. See
[Getting Started with Kubernetes](/docs/platforms/kubernetes/getting-started/) for more
info. {{% /alert %}}
[Getting Started with Kubernetes](/docs/platforms/kubernetes/getting-started/)
for more info. {{% /alert %}}

Attaching Kubernetes resource metadata to OpenTelemetry traces is useful to
identify which resource (such as a pod) is failing or having performance
Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2022/k8s-otel-expose/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ in this setup are mentioned in brackets.
[v1.2.1] installed.
- A Kubernetes [v1.23.3] edge cluster to create a test cluster. Using
[Kind](https://kind.sigs.k8s.io/) is recommended.
- Installed [OpenTelemetry Operator](/docs/platforms/kubernetes/operator/) [v0.58.0] on
both ends.
- Installed [OpenTelemetry Operator](/docs/platforms/kubernetes/operator/)
[v0.58.0] on both ends.
- Installed [Jaeger Operator](https://www.jaegertracing.io/docs/1.37/operator/)
[v1.37.0] on your public cluster.
- Installed [cert-manager](https://cert-manager.io/) [v1.9.1] on your public
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2022/tail-sampling/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -227,4 +227,4 @@ for more information.

_A version of this article was [originally posted][] on the New Relic blog._

[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2022/troubleshooting-nodejs.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,4 +385,4 @@ For a list of OpenTelemetry vendors, see [Vendors](/ecosystem/vendors/).

_A version of this article was [originally posted][] on the Aspecto blog._

[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2022/v1.0-trio.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,4 @@ new languages (Ruby, JavaScript, and Erlang/Elixir) have had their first 1.0
releases, joining the existing GA releases from C++, Go, Java, .NET, Python and
Swift. Read all the details from the [announcement][].

[announcement]: {{% param canonical_url %}}
[announcement]: <{{% param canonical_url %}}>
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ ongoing issues in critical workflows that could potentially impact customer
experience. The Observability landscape is an ever-changing one and recent
developments in the OpenTelemetry world forced us to rethink our strategy in
order to pivot to using it. eBay’s observability platform Sherlock.io provides
developers and Site Reliability Engineers (SREs) with a robust set of
cloud native offerings to observe the various applications that power the eBay
developers and Site Reliability Engineers (SREs) with a robust set of cloud
native offerings to observe the various applications that power the eBay
ecosystem. Sherlock.io supports the three pillars of observability — metrics,
logs and traces. The platform’s metric store is a clustered and sharded
implementation of the Prometheus storage engine. We use the Metricbeat agent to
Expand Down Expand Up @@ -353,4 +353,4 @@ OpenTelemetry Collector community:

_A version of this article was [originally posted][] on the eBay Tech Blog._

[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
10 changes: 5 additions & 5 deletions content/en/blog/2023/contributing-to-otel/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,11 +145,11 @@ Feeling a little more adventurous? Then why not join one of the other OTel
(SIGs)? By joining a SIG, you can contribute to things like (but not limited to)
SDK development, auto-instrumentation of libraries, the
[OTel Collector](/docs/collector/), and the
[OTel Operator](/docs/platforms/kubernetes/operator/). You don't even need to be a regular
contributor. Sometimes, contributions come out of necessity. Like maybe you
found a bug in the Collector. Why not take a stab at fixing it? Or maybe there's
a feature that you and your team desperately need. Again, why not take a stab at
implementing it?
[OTel Operator](/docs/platforms/kubernetes/operator/). You don't even need to be
a regular contributor. Sometimes, contributions come out of necessity. Like
maybe you found a bug in the Collector. Why not take a stab at fixing it? Or
maybe there's a feature that you and your team desperately need. Again, why not
take a stab at implementing it?

Now, before you go off writing code, you should make sure that you:

Expand Down
9 changes: 5 additions & 4 deletions content/en/blog/2023/end-user-q-and-a-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,8 +156,8 @@ others are still instrumented using the [legacy OpenTracing
[using shims](/docs/migration/opentracing/).

The OpenTelemetry Operator is being implemented to auto-instrument Java and .NET
code. Among other things, the [OTel Operator](/docs/platforms/kubernetes/operator/)
supports injecting and
code. Among other things, the
[OTel Operator](/docs/platforms/kubernetes/operator/) supports injecting and
[configuring auto-instrumentation](/docs/platforms/kubernetes/operator/automatic/#configure-automatic-instrumentation)
in .NET, Java, Python, and Node.js. Iris hopes that Go auto-instrumentation will
be available in the near-future. To track progress of auto-instrumentation in
Expand Down Expand Up @@ -255,8 +255,9 @@ would be a bottleneck in terms of load and single point of failure. The team
currently has one
[OpenTelemetry Collector agent](/docs/collector/deployment/agent/) per
Kubernetes cluster. The end goal is to replace those agents with the
[OTel Operator](/docs/platforms/kubernetes/operator/) instead, which allows you to deploy
and configure the OTel Collector and inject and configure auto-instrumentation.
[OTel Operator](/docs/platforms/kubernetes/operator/) instead, which allows you
to deploy and configure the OTel Collector and inject and configure
auto-instrumentation.

Everything is then sent to a central OTel Collector (i.e. an
[OTel Collector gateway](/docs/collector/deployment/gateway/)) per data center,
Expand Down
3 changes: 1 addition & 2 deletions content/en/blog/2023/exponential-histograms.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,5 +198,4 @@ _A version of this article was [originally posted][] to the author's blog._
/docs/specs/otel/metrics/sdk/#base2-exponential-bucket-histogram-aggregation
[Why Histograms?]: ../why-histograms/
[Histograms vs Summaries]: ../histograms-vs-summaries/
[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
2 changes: 1 addition & 1 deletion content/en/blog/2023/histograms-vs-summaries/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,4 +110,4 @@ Until then, here are some talks I found helpful:

_A version of this article was [originally posted][] to the author's blog._

[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
4 changes: 2 additions & 2 deletions content/en/blog/2023/lambda-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ cSpell:ignore: adot otel-faas socha
The
[Functions-as-a-Service (FaaS) SIG](https://docs.google.com/document/d/187XYoQcXQ9JxS_5v2wvZ0NEysaJ02xoOYNXj08pT0zc)
is incredibly excited to announce that the release of OpenTelemetry Lambda
layers, and associated [documentation](/docs/platforms/faas/) on how to monitor Amazon Web
Services (AWS) Lambdas.
layers, and associated [documentation](/docs/platforms/faas/) on how to monitor
Amazon Web Services (AWS) Lambdas.

## OTel FaaS repackaged

Expand Down
4 changes: 2 additions & 2 deletions content/en/blog/2023/opamp-status/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,8 +105,8 @@ with a backlog of issues created to guide further development.
## OpAMP in Kubernetes

In OTel we have dedicated support for Kubernetes as a compute platform via the
[OpenTelemetry Operator for Kubernetes](/docs/platforms/kubernetes/operator/). In this
context, we're also working on OpAMP support in Kubernetes which will be
[OpenTelemetry Operator for Kubernetes](/docs/platforms/kubernetes/operator/).
In this context, we're also working on OpAMP support in Kubernetes which will be
available through a
[bridge component](https://docs.google.com/document/d/1M8VLNe_sv1MIfu5bUR5OV_vrMBnAI7IJN-7-IAr37JY/)
to be deployed by the OpenTelemetry Operator:
Expand Down
2 changes: 1 addition & 1 deletion content/en/blog/2023/why-histograms/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,4 +93,4 @@ avoid these subtle problems if they apply to you.

_A version of this article was [originally posted][] to the author's blog._

[originally posted]: {{% param canonical_url %}}
[originally posted]: <{{% param canonical_url %}}>
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ OTLP/JSON format, with a JSON object per line. The log records are nested in the

## Configure the Collector to ingest the OTLP/JSON logs

{{< figure class="figure" src="otel-collector-otlpjson-pipeline.png" attr="View OTel Collector pipeline with OTelBin" attrlink="https://www.otelbin.io/s/69739d790cf279c203fc8efc86ad1a876a2fc01a" >}}
{{< figure class="figure" src="otel-collector-otlpjson-pipeline.png" attr="View OTel Collector pipeline with OTelBin" attrlink=`https://www.otelbin.io/s/69739d790cf279c203fc8efc86ad1a876a2fc01a` >}}

```yaml
# tested with otelcol-contrib v0.112.0
Expand Down
3 changes: 1 addition & 2 deletions content/en/blog/2025/otel-mainframe-priorities-survey.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,5 @@ OpenTelemetry on Mainframe SIG, join the conversation at
_A version of this article was [originally posted] on the Open Mainframe Project
blog._

[originally posted]: {{% param canonical_url %}}

[originally posted]: <{{% param canonical_url %}}>
[survey]: https://www.surveymonkey.com/r/HGTD2KJ
34 changes: 16 additions & 18 deletions content/en/docs/collector/building/receiver.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,8 +279,8 @@ type Config struct {
Now that you have access to the settings, you can provide any kind of validation
needed for those values by implementing the `Validate` method according to the
optional
[ConfigValidator](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/component/config.go#L50) interface.
[ConfigValidator](<https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% param vers %}}/component/config.go#L50>)
interface.

In this case, the `interval` value will be optional (we will look at generating
default values later) but when defined should be at least 1 minute (1m) and the
Expand Down Expand Up @@ -330,18 +330,18 @@ func (cfg *Config) Validate() error {

If you want to take a closer look at the structs and interfaces involved in the
configuration aspects of a component, take a look at the
[component/config.go](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/component/config.go) file inside the Collector's GitHub project.
[component/config.go](<https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% param vers %}}/component/config.go>)
file inside the Collector's GitHub project.

## Implementing the receiver.Factory interface

The `tailtracer` receiver has to provide a `receiver.Factory` implementation,
and although you will find a `receiver.Factory` interface (you can find its
definition in the
[receiver/receiver.go](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/receiver/receiver.go#L58) file within the Collector's project),
the right way to provide the implementation is by using the functions available
within the `go.opentelemetry.io/collector/receiver` package.
[receiver/receiver.go](<https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% param vers %}}/receiver/receiver.go#L58>)
file within the Collector's project), the right way to provide the
implementation is by using the functions available within the
`go.opentelemetry.io/collector/receiver` package.

Create a file named `factory.go`:

Expand Down Expand Up @@ -595,9 +595,9 @@ func NewFactory() receiver.Factory {
## Implementing the receiver component

All the receiver APIs are currently declared in the
[receiver/receiver.go](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/receiver/receiver.go) file within the Collector's project, open
the file and take a minute to browse through all the interfaces.
[receiver/receiver.go](<https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% param vers %}}/receiver/receiver.go>)
file within the Collector's project, open the file and take a minute to browse
through all the interfaces.

Notice that `receiver.Traces` (and its siblings `receiver.Metrics` and
`receiver.Logs`) at this point in time, doesn't describe any specific methods
Expand Down Expand Up @@ -1393,8 +1393,7 @@ creating a trace.
You will start with a type called `ptrace.ResourceSpans` which represents the
resource and all the operations that it either originated or received while
participating in a trace. You can find its definition within the
[/pdata/internal/data/protogen/trace/v1/trace.pb.go](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/pdata/internal/data/protogen/trace/v1/trace.pb.go).
[/pdata/internal/data/protogen/trace/v1/trace.pb.go](<https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% param vers %}}/pdata/internal/data/protogen/trace/v1/trace.pb.go>).

`ptrace.Traces` has a method named `ResourceSpans()` which returns an instance
of a helper type called `ptrace.ResourceSpansSlice`. The
Expand Down Expand Up @@ -1454,8 +1453,8 @@ pair format represented by the `pcommon.Map` type.

You can check the definition of the `pcommon.Map` type and the related helper
functions to create attribute values using the supported formats in the
[/pdata/pcommon/map.go](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/pdata/pcommon/map.go) file within the Collector's GitHub project.
[/pdata/pcommon/map.go](<https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% param vers %}}/pdata/pcommon/map.go>)
file within the Collector's GitHub project.

Key/value pairs provide a lot of flexibility to help model your `Resource` data,
so the OTel specification has some guidelines in place to help organize and
Expand Down Expand Up @@ -1517,9 +1516,8 @@ convention to represent that information on its `Resource`.

All the resource semantic convention attribute names and well known-values are
kept within the
[/semconv/v1.9.0/generated_resource.go](https://github.com/open-telemetry/opentelemetry-collector/blob/v{{%
param vers %}}/semconv/v1.9.0/generated_resource.go) file within the Collector's
GitHub project.
[/semconv/v1.9.0/generated_resource.go](<https://github.com/open-telemetry/opentelemetry-collector/blob/v{{% param vers %}}/semconv/v1.9.0/generated_resource.go>)
file within the Collector's GitHub project.

Let's create a function to read the field values from an `BackendSystem`
instance and write them as attributes into a `pcommon.Resource` instance. Open
Expand Down
5 changes: 2 additions & 3 deletions content/en/docs/contributing/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,8 @@ One of the best ways to help make OTel docs better is to fix an existing issue.
> process.
{.mt-3}

<!-- prettier-ignore -->
[good first issue]: {{% param _issue %}}%22good+first+issue%22
[help wanted]: {{% param _issue %}}%3A%22help+wanted%22
[good first issue]: <{{% param _issue %}}%22good+first+issue%22>
[help wanted]: <{{% param _issue %}}%3A%22help+wanted%22>
[org]: https://github.com/open-telemetry

{{% /alert %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/demo/forking.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ Live demos can be added to the demo
If you have any questions or would like to suggest ways that we can make your
life easier as a fork maintainer, please open an issue.

[demo repository]: {{% param repo %}}
[demo repository]: <{{% param repo %}}>
2 changes: 1 addition & 1 deletion content/en/docs/languages/cpp/exporters.md
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ void InitTracer()
}
```
{{% docs/languages/exporters/outro python "https://opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/classopentelemetry_1_1sdk_1_1trace_1_1SpanExporter.html" %}}
{{% docs/languages/exporters/outro python `https://opentelemetry-cpp.readthedocs.io/en/latest/otel_docs/classopentelemetry_1_1sdk_1_1trace_1_1SpanExporter.html` %}}
{{< tabpane text=true >}} {{% tab Batch %}}
Expand Down
Loading

0 comments on commit 5472965

Please sign in to comment.