Skip to content

Commit dd59ea9

Browse files
fix: Markdownlint issues
1 parent ff9d4a0 commit dd59ea9

File tree

7 files changed

+23
-23
lines changed

7 files changed

+23
-23
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -201,11 +201,11 @@ The ⚠️ ~~strikethrough~~ ⚠️ components are deprecated.
201201
[mongodbatlasreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/mongodbatlasreceiver
202202
[mysqlreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/mysqlreceiver
203203
[nginxreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/nginxreceiver
204-
[nopreceiver]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/receiver/nopreceiver
204+
[nopreceiver]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/receiver/nopreceiver
205205
[nsxtreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/nsxtreceiver
206206
[opencensusreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/opencensusreceiver
207207
[oracledbreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/oracledbreceiver
208-
[otlpreceiver]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/receiver/otlpreceiver
208+
[otlpreceiver]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/receiver/otlpreceiver
209209
[otlpjsonfilereceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/otlpjsonfilereceiver
210210
[podmanreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/podmanreceiver
211211
[postgresqlreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/postgresqlreceiver
@@ -242,7 +242,7 @@ The ⚠️ ~~strikethrough~~ ⚠️ components are deprecated.
242242
[zipkinreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/zipkinreceiver
243243
[zookeeperreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/zookeeperreceiver
244244
[attributesprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/processor/attributesprocessor
245-
[batchprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/processor/batchprocessor
245+
[batchprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/processor/batchprocessor
246246
[cascadingfilterprocessor]: ./pkg/processor/cascadingfilterprocessor
247247
[cumulativetodeltaprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/processor/cumulativetodeltaprocessor
248248
[deltatorateprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/processor/deltatorateprocessor
@@ -254,7 +254,7 @@ The ⚠️ ~~strikethrough~~ ⚠️ components are deprecated.
254254
[k8sattributesprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/processor/k8sattributesprocessor
255255
[logdedupprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/processor/logdedupprocessor
256256
[logstransformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/processor/logstransformprocessor
257-
[memorylimiterprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/processor/memorylimiterprocessor
257+
[memorylimiterprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/processor/memorylimiterprocessor
258258
[metricfrequencyprocessor]: ./pkg/processor/metricfrequencyprocessor
259259
[metricstransformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/processor/metricstransformprocessor
260260
[probabilisticsamplerprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/processor/probabilisticsamplerprocessor
@@ -274,13 +274,13 @@ The ⚠️ ~~strikethrough~~ ⚠️ components are deprecated.
274274
[awss3exporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/awss3exporter
275275
[awskinesisexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/awskinesisexporter
276276
[carbonexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/carbonexporter
277-
[debugexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/exporter/debugexporter
277+
[debugexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/exporter/debugexporter
278278
[fileexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/fileexporter
279279
[kafkaexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/kafkaexporter
280280
[loadbalancingexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/loadbalancingexporter
281-
[nopexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/exporter/nopexporter
282-
[otlpexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/exporter/otlpexporter
283-
[otlphttpexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/exporter/otlphttpexporter
281+
[nopexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/exporter/nopexporter
282+
[otlpexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/exporter/otlpexporter
283+
[otlphttpexporter]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/exporter/otlphttpexporter
284284
[prometheusexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/prometheusexporter
285285
[sumologicexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/sumologicexporter
286286
[syslogexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/exporter/syslogexporter
@@ -304,8 +304,8 @@ The ⚠️ ~~strikethrough~~ ⚠️ components are deprecated.
304304
[pprofextension]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/extension/pprofextension
305305
[sigv4authextension]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/extension/sigv4authextension
306306
[sumologicextension]: ./pkg/extension/sumologicextension
307-
[zpagesextension]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/extension/zpagesextension
308-
[forwardconnector]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/connector/forwardconnector
307+
[zpagesextension]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/extension/zpagesextension
308+
[forwardconnector]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/connector/forwardconnector
309309
[countconnector]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/connector/countconnector
310310
[failoverconnector]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/connector/failoverconnector
311311
[exceptionsconnector]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/connector/exceptionsconnector

docs/configuration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ service:
225225
exporters: [sumologic]
226226
```
227227

228-
[otlpreceiver_readme]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/receiver/otlpreceiver
228+
[otlpreceiver_readme]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/receiver/otlpreceiver
229229

230230
### Putting it all together
231231

@@ -533,7 +533,7 @@ Example configuration with example log can be found in [/examples/otelcolconfigs
533533

534534
[json_parser]: https://github.com/open-telemetry/opentelemetry-log-collection/blob/main/docs/operators/json_parser.md
535535
[filelogreceiver_readme]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.124.1/receiver/filelogreceiver
536-
[debugexporter_docs]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.1/exporter/debugexporter
536+
[debugexporter_docs]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.124.0/exporter/debugexporter
537537

538538
## Setting source category
539539

docs/fips.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ following: <https://go.googlesource.com/go/+/dev.boringcrypto/misc/boring/>
7373
Depending on configuration, Otelcol can act as a TLS client, server, or both. More specifically,
7474
some receivers can accept data via a TLS-wrapped protocol like HTTP or GRPC. Similarly, some
7575
exporters can send data using such a protocol. The configuration is standardized and can be
76-
found [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md).
76+
found in the [readme](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md).
7777

7878
For the purpose of examining the TLS handshake in both of these situations, we'll use the following minimal
7979
configuration:
@@ -175,7 +175,7 @@ client point: uncompressed (0)
175175

176176
## Setting minimum TLS version
177177

178-
While [FIPS 140][fips] doesn't, strictly speaking, mandate a specific TLS version, it is nonetheless a good practice to use a recent version. Otelcol allows TLS to be configured for each component individually, in a standardized manner. You can find the details [here](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md).
178+
While [FIPS 140][fips] doesn't, strictly speaking, mandate a specific TLS version, it is nonetheless a good practice to use a recent version. Otelcol allows TLS to be configured for each component individually, in a standardized manner. You can find the details in the [readme](https://github.com/open-telemetry/opentelemetry-collector/blob/main/config/configtls/README.md).
179179

180180
By default, the minimum TLS version for otel components is `1.2`. This is a good default that is compliant with the standard. At the moment, there is some uncertainty as to
181181
whether BoringCrypto is FIPS-compliant when using TLS `1.3`, so we recommend staying with the default.

docs/migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1514,7 +1514,7 @@ The table below shows how some metrics commonly used by the Installed Collector
15141514
| | | |
15151515
| current | _not available_ | |
15161516

1517-
Full list of metrics available in this receiver can be found [here][dockerstatsmetrics].
1517+
Full list of metrics available in this receiver can be found in the [documentation][dockerstatsmetrics].
15181518

15191519
Unfortunately, Sumo Logic apps don't work with these metric names yet. To convieniently translate them, use [Sumo Logic Schema Processor][sumologicschemaprocessor]:
15201520

docs/testing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
We currently have some legacy E2E tests ported from [our OT fork][ot_fork],
66
which serve as a means of verifying feature parity for tracing as we migrate it
77
to this distribution. The tests are run by CircleCI on demand for `main` and
8-
release branches, and are defined [here][tracing_tests].
8+
release branches, and are defined in the [tests][tracing_tests].
99

1010
In order to run the tests, go to the [CircleCI page][circleci], choose the branch
1111
you want, and manually approve the workflow to run. Note that you need commiter

docs/upgrading.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -645,7 +645,7 @@ To disable the new features, disable the feature gates in otelcol's arguments:
645645
otelcol-sumo --config=file:config.yaml --feature-gates=-receiver.apache.emitServerNameAsResourceAttribute,-receiver.apache.emitPortAsResourceAttribute
646646
```
647647

648-
More information about the feature gates can be found [here][apache-feature-gates].
648+
More information about the feature gates can be found in the [documentation][apache-feature-gates].
649649
The target release for the removal of feature gates is `v0.68`.
650650

651651
### `elasticsearch` receiver: turn on more datapoints
@@ -661,7 +661,7 @@ To disable the new features, disable the feature gates in otelcol's arguments:
661661
otelcol-sumo --config=file:config.yaml --feature-gates=-receiver.elasticsearch.emitClusterHealthDetailedShardMetrics,-receiver.elasticsearch.emitAllIndexOperationMetrics
662662
```
663663

664-
More information about the feature gates can be found [here][elasticsearch-feature-gates].
664+
More information about the feature gates can be found in the [documentation][elasticsearch-feature-gates].
665665
The target release for the removal of feature gates is `v0.71`.
666666

667667
[#5784]: https://github.com/open-telemetry/opentelemetry-collector/pull/5784
@@ -856,8 +856,8 @@ processors:
856856
```
857857

858858
Starting with `v0.51.0-sumo-0`, the `clusterName` option is removed.
859-
This is a result of an upstream change that removes the `k8s.cluster.name` metadata ([link](https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/9885)),
860-
which in turn is a result of Kubernetes libraries removing support for this deprecated and non-functional field ([link](https://github.com/kubernetes/apimachinery/commit/430b920312ca0fa10eca95967764ff08f34083a3)).
859+
This is a result of an upstream change that removes the `k8s.cluster.name` metadata ([PR](https://github.com/open-telemetry/opentelemetry-collector-contrib/pull/9885)),
860+
which in turn is a result of Kubernetes libraries removing support for this deprecated and non-functional field ([commit](https://github.com/kubernetes/apimachinery/commit/430b920312ca0fa10eca95967764ff08f34083a3)).
861861

862862
#### How to upgrade
863863

pkg/extension/sumologicextension/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ It manages:
1616
for later use)
1717
- heartbeats
1818

19-
[sumologicexporter]: ../../exporter/sumologicexporter/
19+
[sumologicexporter]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/sumologicexporter/README.md
2020
[sumologic]: https://www.sumologic.com/
2121
[sumologic_extension_docs]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/extension/sumologicextension/README.md
2222
[contrib_repo]: https://github.com/open-telemetry/opentelemetry-collector-contrib/
@@ -34,7 +34,7 @@ and can be used as an authenticator for the
3434

3535
- `installation_token`: (required) collector installation token for the Sumo Logic service, see
3636
[help][credentials_help] for more details
37-
- `collector_name`: name that will be used for registration; by default the hostname is used. In the event of a conflict, a timestamp will be appended to the name. See [here][clobber] for more information.
37+
- `collector_name`: name that will be used for registration; by default the hostname is used. In the event of a conflict, a timestamp will be appended to the name. See [documentation][clobber] for more information.
3838
- `collector_description`: collector description that will be used for registration
3939
- `collector_category`: collector category that will be used for registration
4040
- `collector_fields`: a map of key value pairs that will be used as collector
@@ -52,7 +52,7 @@ and can be used as an authenticator for the
5252
- `collector_credentials_directory`: directory where state files with registration
5353
info will be stored after successful collector registration
5454
(default: `$HOME/.sumologic-otel-collector`)
55-
- `clobber`: defines whether to delete any existing collector with the same name. See [here][clobber] for more information.
55+
- `clobber`: defines whether to delete any existing collector with the same name. See [documentation][clobber] for more information.
5656
- `force_registration`: defines whether to force registration every time the
5757
collector starts.
5858
This will cause the collector to not look at the locally stored credentials

0 commit comments

Comments
 (0)