docs: merge package api docs (#3255)

Co-authored-by: Daniel Dyla <dyladan@users.noreply.github.com>
open-telemetry · Oct 7, 2022 · b934cbc · b934cbc
1 parent 1864a9a
commit b934cbc
Show file tree

Hide file tree

Showing 9 changed files with 9 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -394,13 +394,13 @@ Collector exporter packages and types are renamed:
 
 [PR-1925](https://github.com/open-telemetry/opentelemetry-js/pull/1925) feat(diag-logger): part 2 - breaking changes - remove api.Logger, api.NoopLogger, core.LogLevel, core.ConsoleLogger
 
-- These PR's remove the previous ```Logger``` and ```LogLevel``` implementations and change the way you should use the replacement ```DiagLogger``` and ```DiagLogLevel```, below are simple examples of how to change your existing usages.
+- These PR's remove the previous `Logger` and `LogLevel` implementations and change the way you should use the replacement `DiagLogger` and `DiagLogLevel`, below are simple examples of how to change your existing usages.
 
 #### Setting the global diagnostic logger
 
-The new global [```api.diag```](https://github.com/open-telemetry/opentelemetry-js-api/blob/main/src/api/diag.ts) provides the ability to set the global diagnostic logger ```setLogger()``` and logging level ```setLogLevel()```, it is also a ```DiagLogger``` implementation and should be directly to log diagnostic messages.
+The new global [`api.diag`](https://github.com/open-telemetry/opentelemetry-js/blob/main/api/src/api/diag.ts) provides the ability to set the global diagnostic logger `setLogger()` and logging level `setLogLevel()`, it is also a `DiagLogger` implementation and should be directly to log diagnostic messages.
 
-All included logger references have been removed in preference to using the global ```api.diag``` directly, so you no longer need to pass around the logger instance via function parameters or included as part of the configuration for a component.
+All included logger references have been removed in preference to using the global `api.diag` directly, so you no longer need to pass around the logger instance via function parameters or included as part of the configuration for a component.
 
 ```javascript
 import { diag, DiagConsoleLogger, DiagLogLevel } from "@opentelemetry/api";

diff --git a/api/README.md b/api/README.md
@@ -15,7 +15,7 @@
   <a href="https://codecov.io/gh/open-telemetry/opentelemetry-js-api/branch/main/">
     <img alt="Codecov Status" src="https://img.shields.io/codecov/c/github/open-telemetry/opentelemetry-js-api?style=for-the-badge">
   </a>
-  <a href="https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE">
+  <a href="https://github.com/open-telemetry/opentelemetry-js/blob/main/api/LICENSE">
     <img alt="license" src="https://img.shields.io/badge/license-Apache_2.0-green.svg?style=for-the-badge">
   </a>
   <br/>
@@ -132,9 +132,9 @@ Apache 2.0 - See [LICENSE][license-url] for more information.
 [opentelemetry-js]: https://github.com/open-telemetry/opentelemetry-js
 
 [discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions
-[license-url]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/LICENSE
+[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/api/LICENSE
 [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
 [npm-url]: https://www.npmjs.com/package/@opentelemetry/api
 [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fapi.svg
-[docs-tracing]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/tracing.md
-[docs-sdk-registration]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/sdk-registration.md
+[docs-tracing]: https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/tracing.md
+[docs-sdk-registration]: https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/sdk-registration.md
diff --git a/api/package.json b/api/package.json
@@ -10,7 +10,7 @@
     "./build/esm/platform/index.js": "./build/esm/platform/browser/index.js",
     "./build/src/platform/index.js": "./build/src/platform/browser/index.js"
   },
-  "repository": "https://github.com/open-telemetry/opentelemetry-js-api.git",
+  "repository": "open-telemetry/opentelemetry-js",
   "scripts": {
     "clean": "tsc --build --clean",
     "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../",

diff --git a/api/docs/context.md → doc/context.md b/api/docs/context.md → doc/context.md
diff --git a/api/docs/library-author.md → doc/library-author.md b/api/docs/library-author.md → doc/library-author.md
diff --git a/api/docs/propagation.md → doc/propagation.md b/api/docs/propagation.md → doc/propagation.md
diff --git a/api/docs/sdk-registration.md → doc/sdk-registration.md b/api/docs/sdk-registration.md → doc/sdk-registration.md
diff --git a/api/docs/tracing.md → doc/tracing.md b/api/docs/tracing.md → doc/tracing.md
diff --git a/packages/opentelemetry-sdk-trace-node/README.md b/packages/opentelemetry-sdk-trace-node/README.md
@@ -117,6 +117,6 @@ 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/blob/main/LICENSE
 [license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat
-[def-context]: https://github.com/open-telemetry/opentelemetry-js-api/blob/main/docs/context.md
+[def-context]: https://github.com/open-telemetry/opentelemetry-js/blob/main/doc/context.md
 [npm-url]: https://www.npmjs.com/package/@opentelemetry/sdk-trace-node
 [npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fsdk-trace-node.svg