This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new f77e0579792 [fix][doc] Remove CPP client lib requirements from Node.js
client docs (#470)
f77e0579792 is described below
commit f77e057979283114390f218d2d232dc9f63b7ef3
Author: Jun Ma <[email protected]>
AuthorDate: Thu Mar 16 07:27:10 2023 +0800
[fix][doc] Remove CPP client lib requirements from Node.js client docs
(#470)
---
docs/client-libraries-cpp-configs.md | 8 ++++----
docs/client-libraries-node-setup.md | 12 +++---------
versioned_docs/version-2.11.x/client-libraries-node.md | 12 +++---------
3 files changed, 10 insertions(+), 22 deletions(-)
diff --git a/docs/client-libraries-cpp-configs.md
b/docs/client-libraries-cpp-configs.md
index f1d8e8dc139..700eca55a94 100644
--- a/docs/client-libraries-cpp-configs.md
+++ b/docs/client-libraries-cpp-configs.md
@@ -6,16 +6,16 @@ sidebar_label: "C++ client"
## Client configuration
-For all available configurations, see
[`ClientConfiguration`](@pulsar:apidoc:cpp@/classpulsar_1_1_client_configuration.html)
+For all available configurations, see
[`ClientConfiguration`](@pulsar:apidoc:cpp@/classpulsar_1_1_client_configuration.html).
## Producer configuration
-For all available configurations, see
[`ProducerConfiguration`](@pulsar:apidoc:cpp@/classpulsar_1_1_producer_configuration.html)
+For all available configurations, see
[`ProducerConfiguration`](@pulsar:apidoc:cpp@/classpulsar_1_1_producer_configuration.html).
## Consumer configuration
-For all available configurations, see
[`ConsumerConfiguration`](@pulsar:apidoc:cpp@/classpulsar_1_1_consumer_configuration.html)
+For all available configurations, see
[`ConsumerConfiguration`](@pulsar:apidoc:cpp@/classpulsar_1_1_consumer_configuration.html).
## Reader configuration
-For all available configurations, see
[`ReaderConfiguration`](@pulsar:apidoc:cpp@/classpulsar_1_1_reader_configuration.html)
+For all available configurations, see
[`ReaderConfiguration`](@pulsar:apidoc:cpp@/classpulsar_1_1_reader_configuration.html).
diff --git a/docs/client-libraries-node-setup.md
b/docs/client-libraries-node-setup.md
index 08f27127bae..a81fe5f3afc 100644
--- a/docs/client-libraries-node-setup.md
+++ b/docs/client-libraries-node-setup.md
@@ -6,23 +6,17 @@ sidebar_label: "Set up"
## Install Node.js client library
-:::tip
-
-Pulsar Node.js client library is based on the C++ client library.
-* You must install the Pulsar C++ client library before installing a Node.js
client. For more details, see [instructions](client-libraries-cpp.md).
-* If an incompatible version of the C++ client is installed, you may fail to
build or run the Node.js library. For the compatibility between each version of
the Node.js client and the C++ client, see
[README](https://github.com/apache/pulsar-client-node/blob/master/README.md).
-
-:::
-
Install the [`pulsar-client`](https://www.npmjs.com/package/pulsar-client)
library via [npm](https://www.npmjs.com/):
```shell
npm install pulsar-client
```
+For more information, see
[README](https://github.com/apache/pulsar-client-node/blob/master/README.md).
+
:::note
-This library only works in Node.js 10.x or later versions because it uses the
[`node-addon-api`](https://github.com/nodejs/node-addon-api) module to wrap the
C++ library.
+This library only works in Node.js 10.x or later versions because it uses the
[`node-addon-api`](https://github.com/nodejs/node-addon-api) module.
:::
diff --git a/versioned_docs/version-2.11.x/client-libraries-node.md
b/versioned_docs/version-2.11.x/client-libraries-node.md
index d414f842b5f..e3fb586bbc0 100644
--- a/versioned_docs/version-2.11.x/client-libraries-node.md
+++ b/versioned_docs/version-2.11.x/client-libraries-node.md
@@ -10,23 +10,17 @@ For 1.3.0 or later versions, [type
definitions](https://github.com/apache/pulsar
## Installation
-:::tip
-
-Pulsar Node.js client library is based on the C++ client library.
-* You must install the Pulsar C++ client library before installing a Node.js
client. For more details, see [instructions](client-libraries-cpp.md).
-* If an incompatible version of the C++ client is installed, you may fail to
build or run the Node.js library. For the compatibility between each version of
the Node.js client and the C++ client, see
[README](https://github.com/apache/pulsar-client-node/blob/master/README.md).
-
-:::
-
Install the [`pulsar-client`](https://www.npmjs.com/package/pulsar-client)
library via [npm](https://www.npmjs.com/):
```shell
npm install pulsar-client
```
+For more information, see
[README](https://github.com/apache/pulsar-client-node/blob/master/README.md).
+
:::note
-This library only works in Node.js 10.x or later versions because it uses the
[`node-addon-api`](https://github.com/nodejs/node-addon-api) module to wrap the
C++ library.
+This library only works in Node.js 10.x or later versions because it uses the
[`node-addon-api`](https://github.com/nodejs/node-addon-api) module.
:::
