Skip to content

Commit

Permalink
chore: fix markdownlint issues (#3252)
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Dyla <[email protected]>
  • Loading branch information
pichlermarc and dyladan authored Sep 14, 2022
1 parent 9c102b7 commit ec56837
Show file tree
Hide file tree
Showing 8 changed files with 4 additions and 17 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ If you are a library author looking to build OpenTelemetry into your library, pl
### Node Support

Only Node.js Active or Maintenance LTS versions are supported.
Previous versions of node _may_ work, but they are not tested by OpenTelemetry and they are not guaranteed to work.
Previous versions of node *may* work, but they are not tested by OpenTelemetry and they are not guaranteed to work.
Please note that versions of Node.JS v8 prior to `v8.12.0` will NOT work, because OpenTelemetry Node depends on the `perf_hooks` module introduced in `v8.5.0` and `performance.timeOrigin` that is set correctly starting in `v8.12.0`.

### Browser Support
Expand Down Expand Up @@ -556,6 +556,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[otel-api]: https://github.com/open-telemetry/opentelemetry-js-api
[otel-core]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-core
[otel-propagator-b3]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-propagator-b3
[generate-api-documentation]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md#generating-api-documentation

[spec-versioning]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/versioning-and-stability.md
2 changes: 1 addition & 1 deletion doc/web-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ browsing context only.

[`window`]: https://developer.mozilla.org/en-US/docs/Web/API/window
[`document`]: https://developer.mozilla.org/en-US/docs/Web/API/Document
[`navigator]: https://developer.mozilla.org/en-US/docs/Web/API/Navigator
[`navigator`]: https://developer.mozilla.org/en-US/docs/Web/API/Navigator
2 changes: 0 additions & 2 deletions examples/basic-tracer-node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,3 @@ Click on the trace to view its details.
## LICENSE

Apache License 2.0

[opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-exporter-otlp-http
5 changes: 1 addition & 4 deletions experimental/packages/api-logs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[npm-url]: https://www.npmjs.com/package/@opentelemetry/api-metrics
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi-metrics.svg

[metrics-api-docs]: https://open-telemetry.github.io/opentelemetry-js/modules/_opentelemetry_api_metrics.html

[other-tracing-backends]: https://github.com/open-telemetry/opentelemetry-js#trace-exporters
[logs-api-docs]: https://open-telemetry.github.io/opentelemetry-js/modules/_opentelemetry_api_logs.html
3 changes: 0 additions & 3 deletions experimental/packages/otlp-exporter-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,3 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[npm-url-proto]: https://www.npmjs.com/package/@opentelemetry/otlp-proto-exporter-base
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fotlp-exporter-base.svg
[opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-collector
[opentelemetry-spec-protocol-exporter]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/protocol/exporter.md#configuration-options
[semconv-resource-service-name]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service
[metrics-exporter-url]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-http
2 changes: 0 additions & 2 deletions experimental/packages/otlp-grpc-exporter-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,3 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[npm-url]: https://www.npmjs.com/package/@opentelemetry/otlp-grpc-exporter-base
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fotlp-grpc-exporter-base.svg
[opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-collector
[semconv-resource-service-name]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service
[metrics-exporter-url]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-grpc
2 changes: 0 additions & 2 deletions experimental/packages/otlp-proto-exporter-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,5 +29,3 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[npm-url]: https://www.npmjs.com/package/@opentelemetry/otlp-proto-exporter-base
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fotlp-proto-exporter-base.svg
[opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-collector
[semconv-resource-service-name]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service
[metrics-exporter-url]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-exporter-metrics-otlp-proto
2 changes: 1 addition & 1 deletion packages/opentelemetry-context-async-hooks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

This package provides two [`ContextManager`](https://open-telemetry.github.io/opentelemetry-js-api/interfaces/contextmanager.html) implementations built on APIs from Node.js's [`async_hooks`][async-hooks-doc] module. If you're looking for a `ContextManager` to use in browser environments, consider [opentelemetry-context-zone](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-context-zone) or [opentelemetry-context-zone-peer-dep](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-context-zone-peer-dep).

The definition of the `ContextManager` interface and the problem it solves can be found [here](def-context-manager).
The definition of the `ContextManager` interface and the problem it solves can be found [here][def-context-manager].

## API

Expand Down

0 comments on commit ec56837

Please sign in to comment.