Skip to content

Commit a2b71cf

Browse files
rauno56vmarchaud
andauthored
docs: format supported versions the same way across the readmes (open-telemetry#797)
Co-authored-by: Valentin Marchaud <[email protected]>
1 parent f497313 commit a2b71cf

File tree

7 files changed

+16
-19
lines changed

7 files changed

+16
-19
lines changed

.github/workflows/release-please.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ jobs:
5151
npx lerna bootstrap --no-ci
5252
5353
# Release Please has already incremented versions and published tags, so we just
54-
# need to publish all unpublished versions to NPM here
54+
# need to publish all unpublished versions to npm here
5555
# See: https://github.com/lerna/lerna/tree/main/commands/publish#bump-from-package
56-
- name: Publish to NPM
56+
- name: Publish to npm
5757
if: ${{ steps.release.outputs.releases_created }}
5858
env:
5959
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ This repo is generally meant for hosting components that work with popular open-
8787

8888
### Adding a New Vendor Component
8989

90-
Vendor components that are hosted in this repo will be versioned the same as all other contrib components, and released in lockstep with them under the `@opentelemetry` org in NPM.
90+
Vendor components that are hosted in this repo will be versioned the same as all other contrib components, and released in lockstep with them under the `@opentelemetry` org in npm.
9191

9292
In exchange, vendor component contributors are expected to:
9393

RELEASING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Releasing OpenTelemetry Packages (for Maintainers Only)
22

33
This repository uses [Release Please](https://github.com/googleapis/release-please) to manage its releases automatically and independently.
4-
Modified packages are automatically published to NPM when the auto-generated Release Please PR is merged.
4+
Modified packages are automatically published to npm when the auto-generated Release Please PR is merged.
55

66
## Manual Publishing Process
77

plugins/node/opentelemetry-instrumentation-hapi/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![devDependencies][devDependencies-image]][devDependencies-url]
66
[![Apache License][license-image]][license-image]
77

8-
This module provides automatic instrumentation for [`Hapi`](https://hapi.dev).
8+
This module provides automatic instrumentation for the [Hapi Framework](https://hapi.dev)(`@hapi/hapi` package).
99

1010
For automatic instrumentation see the
1111
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
@@ -20,7 +20,7 @@ npm install --save @opentelemetry/instrumentation-hapi
2020

2121
### Supported Versions
2222

23-
- @hapi/hapi `^17.0.0`
23+
- `>=17.0.0 <21`
2424

2525
## Usage
2626

plugins/node/opentelemetry-instrumentation-koa/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
[![devDependencies][devDependencies-image]][devDependencies-url]
66
[![Apache License][license-image]][license-image]
77

8-
This module provides automatic instrumentation for [`Koa`](https://github.com/koajs/koa).
8+
This module provides automatic instrumentation for [Koa](https://github.com/koajs/koa).
99

1010
For automatic instrumentation see the
11-
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
11+
[`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
1212

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

@@ -20,7 +20,7 @@ npm install --save @opentelemetry/instrumentation-koa
2020

2121
### Supported Versions
2222

23-
- Koa `^2.0.0`
23+
- `^2.0.0`
2424

2525
## Usage
2626

@@ -41,7 +41,7 @@ registerInstrumentations({
4141
});
4242
```
4343

44-
See [examples/koa](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/koa) for a short example using both Koa and @koa/router
44+
See [`examples/koa`](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/examples/koa) for a short example using both Koa and @koa/router
4545

4646
### Koa Instrumentation Options
4747

@@ -56,7 +56,7 @@ See [examples/koa](https://github.com/open-telemetry/opentelemetry-js-contrib/tr
5656

5757
## Koa Packages
5858

59-
This package provides automatic tracing for middleware added using either the core [`Koa`](https://github.com/koajs/koa) package or the [`@koa/router`](https://github.com/koajs/router) package.
59+
This package provides automatic tracing for middleware added using either the core [`koa`](https://github.com/koajs/koa) package or the [`@koa/router`](https://github.com/koajs/router) package.
6060

6161
## Useful links
6262

plugins/node/opentelemetry-instrumentation-mongodb/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ npm install --save @opentelemetry/instrumentation-mongodb
2020

2121
### Supported Versions
2222

23-
- `'>=3.3 <4`
23+
- `>=3.3 <4`
2424

2525
## Usage
2626

plugins/node/opentelemetry-instrumentation-pg/README.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![devDependencies][devDependencies-image]][devDependencies-url]
66
[![Apache License][license-image]][license-image]
77

8-
This module provides automatic instrumentation for [`pg and pg-pool`](https://github.com/brianc/node-postgres)
8+
This module provides automatic instrumentation for [`pg`](https://github.com/brianc/node-postgres).
99

1010
For automatic instrumentation see the
1111
[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
@@ -18,7 +18,9 @@ Compatible with OpenTelemetry JS API and SDK `1.0+`.
1818
npm install --save @opentelemetry/instrumentation-pg
1919
```
2020

21-
It will install Instrumentation for PG and PG-POOL
21+
### Supported Versions
22+
23+
- `>=7 <9`
2224

2325
## Usage
2426

@@ -50,11 +52,6 @@ PostgreSQL instrumentation has few options available to choose from. You can set
5052
| [`enhancedDatabaseReporting`](https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-pg/src/pg.ts#L48) | `boolean` | If true, additional information about query parameters and results will be attached (as `attributes`) to spans representing database operations |
5153
| `responseHook` | `PgInstrumentationExecutionResponseHook` (function) | Function for adding custom attributes from db response |
5254

53-
## Supported Versions
54-
55-
- [pg](https://npmjs.com/package/pg): `7.x`, `8.*`
56-
- [pg-pool](https://npmjs.com/package/pg-pool): `2.x`, `3.*` (Installed by `pg`)
57-
5855
## Useful links
5956

6057
- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>

0 commit comments

Comments
 (0)