Skip to content

Commit

Permalink
docs: fix broken links (#945)
Browse files Browse the repository at this point in the history
* docs: remove all broken david-dm links

* docs: fix links to node tracing sdk

* docs: fix more links
  • Loading branch information
rauno56 authored Mar 17, 2022
1 parent 5f63606 commit acd6a6f
Show file tree
Hide file tree
Showing 63 changed files with 50 additions and 305 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
<p align="center">
<strong>
<a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/getting-started/README.md">Getting Started<a/>
<a href="https://opentelemetry.io/docs/js/getting_started">Getting Started<a/>
&nbsp;&nbsp;&bull;&nbsp;&nbsp;
<a href="https://open-telemetry.github.io/opentelemetry-js">API Documentation<a/>
</strong>
Expand Down
6 changes: 0 additions & 6 deletions detectors/node/opentelemetry-resource-detector-aws/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# OpenTelemetry Resource Detector for AWS

[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-image]

[component owners](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/.github/component_owners.yml): @willarmiros @NathanielRN
Expand Down Expand Up @@ -52,9 +50,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=detectors%2Fnode%2Fopentelemetry-resource-detector-aws
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=detectors%2Fnode%2Fopentelemetry-resource-detector-aws
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=detectors%2Fnode%2Fopentelemetry-resource-detector-aws&type=dev
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=detectors%2Fnode%2Fopentelemetry-resource-detector-aws&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-aws
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-aws.svg
6 changes: 0 additions & 6 deletions detectors/node/opentelemetry-resource-detector-gcp/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# OpenTelemetry Resource Detector for GCP

[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-image]

Resource detector for Google Cloud Platform.
Expand Down Expand Up @@ -45,9 +43,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=detectors%2Fnode%2Fopentelemetry-resource-detector-gcp
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=detectors%2Fnode%2Fopentelemetry-resource-detector-gcp
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=detectors%2Fnode%2Fopentelemetry-resource-detector-gcp&type=dev
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=detectors%2Fnode%2Fopentelemetry-resource-detector-gcp&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-gcp
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-gcp.svg
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# OpenTelemetry Resource Detector for GitHub Actions

[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-image]

Resource detector for GitHub Actions.
Expand Down Expand Up @@ -49,9 +47,5 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=detectors%2Fnode%2Fopentelemetry-resource-detector-github
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=detectors%2Fnode%2Fopentelemetry-resource-detector-github
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=detectors%2Fnode%2Fopentelemetry-resource-detector-github&type=dev
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=detectors%2Fnode%2Fopentelemetry-resource-detector-github&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/resource-detector-github
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fresource-detector-github.svg
2 changes: 1 addition & 1 deletion examples/connect/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Go to Zipkin with your browser <http://localhost:9411/>
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/dns/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/express/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/fastify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Go to Zipkin with your browser <http://localhost:9411/>
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
4 changes: 2 additions & 2 deletions examples/graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ This example shows how to use 2 popular graphql servers
- [Apollo GraphQL](https://www.npmjs.com/package/apollo-server)
- [GraphQL HTTP Server Middleware](https://www.npmjs.com/package/express-graphql)

and [@opentelemetry/instrumentation-graphql](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation-graphql) to instrument a simple Node.js application.
and [@opentelemetry/instrumentation-graphql](https://www.npmjs.com/package/@opentelemetry/instrumentation-graphql) to instrument a simple Node.js application.

This instrumentation should work with any graphql server as it instruments graphql directly.

This example will export spans data simultaneously using [Exporter Collector](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-exporter-collector).
This example will export spans data simultaneously using [@opentelemetry/exporter-trace-otlp-http](https://www.npmjs.com/package/@opentelemetry/exporter-trace-otlp-http).

## Installation

Expand Down
4 changes: 2 additions & 2 deletions examples/grpc-census-prop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ that is already instrumented using OpenCensus.
If both sides of gRPC communication are using OpenTelemetry instrumentation then
the `propagator-grpc-census-binary` propagator isn't required. Context will be
propagated using the `traceparent` header (thanks to the
[HttpTraceContextPropagator](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-core/src/trace/HttpTraceContextPropagator.ts)
[HttpTraceContextPropagator](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-core/src/trace/W3CTraceContextPropagator.ts)
propagator from opentelemetry-core). If there is a mix of OpenCensus and OpenTelemetry
instrumentation then the `propagator-grpc-census-binary` propagator allows OpenTelemetry
to propagate context through the `grpc-trace-bin` binary header.
Expand Down Expand Up @@ -124,7 +124,7 @@ See [combination4](./combination4.md) for example output
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node-sdk>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node-sdk>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/grpc_dynamic_codegen/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node-sdk>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node-sdk>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/hapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/koa/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/mongodb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/mysql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/postgres/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/react-load/preact/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.

[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[otel]: https://opentelemetry.io/
[otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node
[otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node
2 changes: 1 addition & 1 deletion examples/react-load/react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,4 @@ Apache 2.0 - See [LICENSE][license-url] for more information.

[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[otel]: https://opentelemetry.io/
[otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node
[otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node
2 changes: 1 addition & 1 deletion examples/redis/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Go to Jaeger with your browser <http://localhost:16686/trace/(your-trace-id)> (e
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/restify/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ npm run jaeger:client # Run the client in a separate terminal
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
2 changes: 1 addition & 1 deletion examples/router/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ npm run jaeger:client # Run the client in a separate terminal
## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node>
- For more information on OpenTelemetry for Node.js, visit: <https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node>

## LICENSE

Expand Down
8 changes: 1 addition & 7 deletions metapackages/auto-instrumentations-node/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# OpenTelemetry Meta Packages for Node

[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-url]

This module provides a simple way to initialize multiple Node instrumentations.
Expand Down Expand Up @@ -56,7 +54,7 @@ registerInstrumentations({

## Supported instrumentations

- [@opentelemetry/instrumentation-amqplib](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-amqplib)
- [@opentelemetry/instrumentation-amqplib](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-amqplib)
- [@opentelemetry/instrumentation-aws-lambda](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-lambda)
- [@opentelemetry/instrumentation-aws-sdk](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-aws-sdk)
- [@opentelemetry/instrumentation-bunyan](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-bunyan)
Expand Down Expand Up @@ -101,9 +99,5 @@ APACHE 2.0 - See [LICENSE][license-url] for more information.

[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=metapackages%2Fauto-instrumentations-node
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=metapackages%2Fauto-instrumentations-node
[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js-contrib.svg?path=metapackages%2Fauto-instrumentations-node&type=dev
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=metapackages%2Fauto-instrumentations-node&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fauto-instrumentations-node.svg
6 changes: 0 additions & 6 deletions metapackages/auto-instrumentations-web/README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# OpenTelemetry Meta Packages for Web

[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Apache License][license-image]][license-url]

Compatible with OpenTelemetry JS API and SDK `1.0+`.
Expand Down Expand Up @@ -59,9 +57,5 @@ APACHE 2.0 - See [LICENSE][license-url] for more information.

[license-url]: https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
[dependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib.svg?path=packages%2Fauto-instrumentations-web
[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fauto-instrumentations-web
[devDependencies-image]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib.svg?path=packages%2Fauto-instrumentations-web&type=dev
[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js-contrib?path=packages%2Fauto-instrumentations-web&type=dev
[npm-url]: https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-web
[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fauto-instrumentations-web.svg
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# OpenTelemetry Browser Extension

This browser extension allows you to inject [OpenTelemetry](https://opentelemetry.io/) instrumentation in any web page. It uses the [Web SDK](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-web) and can export data to Zipkin or an OpenTelemetry Collector.
This browser extension allows you to inject [OpenTelemetry](https://opentelemetry.io/) instrumentation in any web page. It uses the [Web SDK](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-web) and can export data to Zipkin or an OpenTelemetry Collector.

Compatible with OpenTelemetry JS API and SDK `1.0+`.

Expand Down
Loading

0 comments on commit acd6a6f

Please sign in to comment.