Skip to content

Commit

Permalink
ci: lint markdown files (open-telemetry#1147)
Browse files Browse the repository at this point in the history
* ci: add markdown linting

Signed-off-by: Naseem <naseem@transit.app>

* fix: lint markdown files

Signed-off-by: Naseem <naseem@transit.app>

* docs: add markdown lint configuration

Signed-off-by: Naseem <naseem@transit.app>

* docs: lint change log

Signed-off-by: Naseem <naseem@transit.app>
  • Loading branch information
Naseem authored and dyladan committed Feb 18, 2021
1 parent 09e3787 commit 6c4cd1d
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 1 deletion.
6 changes: 6 additions & 0 deletions api/.markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"MD013": false,
"MD024": false,
"MD033": false,
"MD041": false
}
3 changes: 3 additions & 0 deletions api/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# OpenTelemetry API for JavaScript

[![Gitter chat][gitter-image]][gitter-url]
[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
Expand Down Expand Up @@ -99,6 +100,7 @@ api.metrics.setGlobalMeterProvider(meterProvider);
Because the npm installer and node module resolution algorithm could potentially allow two or more copies of any given package to exist within the same `node_modules` structure, the OpenTelemetry API takes advantage of a variable on the `global` object to store the global API. When an API method in the API package is called, it checks if this `global` API exists and proxies calls to it if and only if it is a compatible API version. This means if a package has a dependency on an OpenTelemetry API version which is not compatible with the API used by the end user, the package will receive a no-op implementation of the API.

## Advanced Use

### API Registration Options

If you prefer to choose your own propagator or context manager, you may pass an options object into the `tracerProvider.register()` method. Omitted or `undefined` options will be replaced by a default value and `null` values will be skipped.
Expand Down Expand Up @@ -176,6 +178,7 @@ async function doSomething() {
```

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
- For help or feedback on this project, join us on [gitter][gitter-url]
Expand Down
4 changes: 3 additions & 1 deletion api/packages/opentelemetry-context-base/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# OpenTelemetry Base Context Manager

[![Gitter chat][gitter-image]][gitter-url]
[![NPM Published Version][npm-img]][npm-url]
[![dependencies][dependencies-image]][dependencies-url]
Expand All @@ -7,7 +8,7 @@

This package provides the ContextManager interface (which is used by concrete implementations) and a no-op implementation (which is used internally when no context propagation is defined). It's intended for use both on the server and in the browser.

## What is a Context Manager ?
## What is a Context Manager

To understand why they exists, we'll need to understand how Javascript works: when you make native function call (networks, setInterval etc) you generally call C++ code that will later callback your own code.

Expand All @@ -18,6 +19,7 @@ ContextManager's aim to offer exactly that, it's API offer to store an object in
This package only include the interface and a Noop implementation, for more information please see the [async-hooks based ContextManager][ah-context-manager] for NodeJS.

## Useful links

- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>
- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>
- For help or feedback on this project, join us on [gitter][gitter-url]
Expand Down

0 comments on commit 6c4cd1d

Please sign in to comment.