docs: format supported versions the same way across the readmes (open…

…-telemetry#797)

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

.github/workflows/release-please.yml

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

CONTRIBUTING.md

@@ -87,7 +87,7 @@ This repo is generally meant for hosting components that work with popular open-
 
 ### Adding a New Vendor Component
 
-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.
+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.
 
 In exchange, vendor component contributors are expected to:
 

RELEASING.md

@@ -1,7 +1,7 @@
 # Releasing OpenTelemetry Packages (for Maintainers Only)
 
 This repository uses [Release Please](https://github.com/googleapis/release-please) to manage its releases automatically and independently.
-Modified packages are automatically published to NPM when the auto-generated Release Please PR is merged.
+Modified packages are automatically published to npm when the auto-generated Release Please PR is merged.
 
 ## Manual Publishing Process
 

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

@@ -5,7 +5,7 @@
 [![devDependencies][devDependencies-image]][devDependencies-url]
 [![Apache License][license-image]][license-image]
 
-This module provides automatic instrumentation for [`Hapi`](https://hapi.dev).
+This module provides automatic instrumentation for the [Hapi Framework](https://hapi.dev)(`@hapi/hapi` package).
 
 For automatic instrumentation see the
 [@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
 
 ### Supported Versions
 
-- @hapi/hapi `^17.0.0`
+- `>=17.0.0 <21`
 
 ## Usage
 

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

@@ -5,10 +5,10 @@
 [![devDependencies][devDependencies-image]][devDependencies-url]
 [![Apache License][license-image]][license-image]
 
-This module provides automatic instrumentation for [`Koa`](https://github.com/koajs/koa).
+This module provides automatic instrumentation for [Koa](https://github.com/koajs/koa).
 
 For automatic instrumentation see the
-[@opentelemetry/sdk-trace-node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
+[`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.
 
 Compatible with OpenTelemetry JS API and SDK `1.0+`.
 
@@ -20,7 +20,7 @@ npm install --save @opentelemetry/instrumentation-koa
 
 ### Supported Versions
 
-- Koa `^2.0.0`
+- `^2.0.0`
 
 ## Usage
 
@@ -41,7 +41,7 @@ registerInstrumentations({
 });
 ```
 
-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
+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
 
 ### Koa Instrumentation Options
 
@@ -56,7 +56,7 @@ See [examples/koa](https://github.com/open-telemetry/opentelemetry-js-contrib/tr
 
 ## Koa Packages
 
-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.
+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.
 
 ## Useful links
 

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

@@ -20,7 +20,7 @@ npm install --save @opentelemetry/instrumentation-mongodb
 
 ### Supported Versions
 
-- `'>=3.3 <4`
+- `>=3.3 <4`
 
 ## Usage
 

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

@@ -5,7 +5,7 @@
 [![devDependencies][devDependencies-image]][devDependencies-url]
 [![Apache License][license-image]][license-image]
 
-This module provides automatic instrumentation for [`pg and pg-pool`](https://github.com/brianc/node-postgres)
+This module provides automatic instrumentation for [`pg`](https://github.com/brianc/node-postgres).
 
 For automatic instrumentation see the
 [@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+`.
 npm install --save @opentelemetry/instrumentation-pg
 ```
 
-It will install Instrumentation for PG and PG-POOL
+### Supported Versions
+
+- `>=7 <9`
 
 ## Usage
 
@@ -50,11 +52,6 @@ PostgreSQL instrumentation has few options available to choose from. You can set
 | [`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 |
 | `responseHook` | `PgInstrumentationExecutionResponseHook` (function) | Function for adding custom attributes from db response |
 
-## Supported Versions
-
-- [pg](https://npmjs.com/package/pg): `7.x`, `8.*`
-- [pg-pool](https://npmjs.com/package/pg-pool): `2.x`, `3.*` (Installed by `pg`)
-
 ## Useful links
 
 - For more information on OpenTelemetry, visit: <https://opentelemetry.io/>