chore: checks links in typedoc html

open-telemetry · Dec 16, 2021 · 0a468f3 · 0a468f3
1 parent 10cd916
commit 0a468f3
Show file tree

Hide file tree

Showing 6 changed files with 27 additions and 47 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -45,18 +45,25 @@ jobs:
             experimental/node_modules
             */*/node_modules
             experimental/*/*/node_modules
-          key: lint-${{ matrix.package-group }}-${{ runner.os }}-${{ matrix.node_version }}-${{ hashFiles('**/package.json') }}-20211009.2
+          key: lint-${{ matrix.package-group }}-${{ runner.os }}-${{ matrix.node_version }}-${{ hashFiles('**/package.json') }}-20211216
 
       # On a cache miss, install dependencies
       - name: Bootstrap
         if: steps.cache.outputs.cache-hit != 'true'
         working-directory: ${{ matrix.package-group }}
         run: |
           npm install --ignore-scripts
-          npx lerna bootstrap --no-ci --ignore-scripts --hoist --nohoist='zone.js' -- --only=dev
+          npx lerna bootstrap --no-ci --ignore-scripts --hoist --nohoist='zone.js'
 
       - name: Lint
         working-directory: ${{ matrix.package-group }}
         run: |
           npm run lint
           npm run lint:examples
+
+      - name: Lint doc files
+        if: ${{ matrix.package-group == '.' }}
+        run: |
+          npm run compile
+          npm run docs
+          npm run docs:test
diff --git a/.github/workflows/markdown-lint.config.json b/.github/workflows/markdown-lint.config.json
diff --git a/.github/workflows/markdown-lint.yml b/.github/workflows/markdown-lint.yml
diff --git a/README.md b/README.md
@@ -33,8 +33,6 @@
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
     <a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/development-guide.md">Development Guide</a>
     &nbsp;&nbsp;&bull;&nbsp;&nbsp;
-    <a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/benchmark/README.md">Benchmarks</a>
-    &nbsp;&nbsp;&bull;&nbsp;&nbsp;
     <a href="https://github.com/open-telemetry/opentelemetry-js/tree/main/examples">Examples</a>
   </strong>
 </p>
@@ -174,7 +172,7 @@ For a more detailed breakdown of feature support see the [specification complian
 We'd love your help!. Use tags [up-for-grabs][up-for-grabs-issues] and
 [good first issue][good-first-issues] to get started with the project. For
 instructions to build and make changes to this project, see the
-[CONTRIBUTING](CONTRIBUTING.md) guide.
+[CONTRIBUTING][CONTRIBUTING] guide.
 
 We have a weekly SIG meeting! See the [community page](https://github.com/open-telemetry/community#javascript-sdk) for meeting details and notes.
 
@@ -370,7 +368,7 @@ Collector exporter packages and types are renamed:
 
 - All plugins have been removed in favor of instrumentations.
 
-- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header endcoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [readme](./packages/opentelemetry-propagator-b3/README.md) for full details and usage.
+- The `@opentelemetry/propagator-b3` package previously exported three propagators: `B3Propagator`,`B3SinglePropagator`, and `B3MultiPropagator`, but now only exports the `B3Propagator`. It extracts b3 context in single and multi-header encodings, and injects context using the single-header encoding by default, but can be configured to inject context using the multi-header endcoding during construction: `new B3Propagator({ injectEncoding: B3InjectEncoding.MULTI_HEADER })`. If you were previously using the `B3SinglePropagator` or `B3MultiPropagator` directly, you should update your code to use the `B3Propagator` with the appropriate configuration. See the [readme][otel-propagator-b3] for full details and usage.
 
 - Sampling configuration via environment variable has changed. If you were using `OTEL_SAMPLING_PROBABILITY` then you should replace it with `OTEL_TRACES_SAMPLER=parentbased_traceidratio` and `OTEL_TRACES_SAMPLER_ARG=<number>` where `<number>` is a number in the [0..1] range, e.g. "0.25". Default is 1.0 if unset.
 
@@ -535,6 +533,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 
 [docs]: https://open-telemetry.github.io/opentelemetry-js
 [compliance-matrix]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/spec-compliance-matrix.md
+[CONTRIBUTING]: https://github.com/open-telemetry/opentelemetry-js/blob/main/CONTRIBUTING.md
 
 [otel-metrics]: https://github.com/open-telemetry/opentelemetry-js/tree/main/experimental/packages/opentelemetry-sdk-metrics-base
 [otel-node]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node
@@ -549,6 +548,7 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [otel-web]: https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-web
 [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
 
 [otel-contrib-instrumentation-dns]: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns

diff --git a/package.json b/package.json
@@ -26,6 +26,7 @@
     "predocs-test": "npm run docs",
     "docs": "typedoc && touch docs/.nojekyll",
     "docs-deploy": "gh-pages --dotfiles --dist docs",
+    "docs:test": "linkinator docs --silent && linkinator doc/*.md --silent",
     "lint": "lerna run lint",
     "lint:changed": "lerna run --concurrency 1 --stream lint --since HEAD --exclude-dependents",
     "lint:fix": "lerna run lint:fix",
@@ -63,6 +64,7 @@
     "husky": "4.3.8",
     "lerna": "3.22.1",
     "lerna-changelog": "1.0.1",
+    "linkinator": "^2.16.2",
     "markdownlint-cli": "0.29.0",
     "semver": "7.3.5",
     "typedoc": "0.22.9",

diff --git a/tsconfig.json b/tsconfig.json
@@ -2,7 +2,8 @@
   "extends": "./tsconfig.base.json",
   "files": [],
   "typedocOptions": {
-    "packages": [
+    "entryPointStrategy": "packages",
+    "entryPoints": [
       "experimental/packages/opentelemetry-api-metrics",
       "experimental/packages/opentelemetry-exporter-trace-otlp-grpc",
       "experimental/packages/opentelemetry-exporter-trace-otlp-http",
@@ -13,6 +14,7 @@
       "experimental/packages/opentelemetry-instrumentation-http",
       "experimental/packages/opentelemetry-instrumentation-xml-http-request",
       "experimental/packages/opentelemetry-instrumentation",
+      "experimental/packages/opentelemetry-sdk-metrics-base",
       "experimental/packages/opentelemetry-sdk-node",
       "experimental/packages/opentelemetry-exporter-metrics-otlp-http",
       "experimental/packages/opentelemetry-exporter-metrics-otlp-grpc",
@@ -26,7 +28,6 @@
       "packages/opentelemetry-propagator-b3",
       "packages/opentelemetry-propagator-jaeger",
       "packages/opentelemetry-resources",
-      "packages/opentelemetry-sdk-metrics-base",
       "packages/opentelemetry-sdk-trace-base",
       "packages/opentelemetry-sdk-trace-node",
       "packages/opentelemetry-sdk-trace-web",
@@ -48,40 +49,40 @@
       "path": "packages/opentelemetry-context-async-hooks"
     },
     {
-      "path": "packages/opentelemetry-context-zone-peer-dep/tsconfig.all.json"
+      "path": "packages/opentelemetry-context-zone-peer-dep"
     },
     {
-      "path": "packages/opentelemetry-context-zone/tsconfig.all.json"
+      "path": "packages/opentelemetry-context-zone"
     },
     {
-      "path": "packages/opentelemetry-core/tsconfig.all.json"
+      "path": "packages/opentelemetry-core"
     },
     {
       "path": "packages/opentelemetry-exporter-jaeger"
     },
     {
-      "path": "packages/opentelemetry-exporter-zipkin/tsconfig.all.json"
+      "path": "packages/opentelemetry-exporter-zipkin"
     },
     {
-      "path": "packages/opentelemetry-propagator-b3/tsconfig.all.json"
+      "path": "packages/opentelemetry-propagator-b3"
     },
     {
       "path": "packages/opentelemetry-propagator-jaeger"
     },
     {
-      "path": "packages/opentelemetry-resources/tsconfig.all.json"
+      "path": "packages/opentelemetry-resources"
     },
     {
-      "path": "packages/opentelemetry-sdk-trace-base/tsconfig.all.json"
+      "path": "packages/opentelemetry-sdk-trace-base"
     },
     {
       "path": "packages/opentelemetry-sdk-trace-node"
     },
     {
-      "path": "packages/opentelemetry-sdk-trace-web/tsconfig.all.json"
+      "path": "packages/opentelemetry-sdk-trace-web"
     },
     {
-      "path": "packages/opentelemetry-semantic-conventions/tsconfig.all.json"
+      "path": "packages/opentelemetry-semantic-conventions"
     },
     {
       "path": "packages/opentelemetry-shim-opentracing"