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 c71b2ab241dc SEO for Client Libraries (#706)
c71b2ab241dc is described below
commit c71b2ab241dc598d81efb705cd996e33976a4769
Author: Zhang Yuxuan <[email protected]>
AuthorDate: Mon Sep 25 21:02:36 2023 +0800
SEO for Client Libraries (#706)
---
docs/client-libraries-clients.md | 1 +
docs/client-libraries-cluster-level-failover.md | 3 ++-
docs/client-libraries-consumers.md | 1 +
docs/client-libraries-cpp-initialize.md | 1 +
docs/client-libraries-cpp-setup.md | 7 +++++--
docs/client-libraries-cpp-use.md | 1 +
docs/client-libraries-dotnet-initialize.md | 1 +
docs/client-libraries-dotnet-setup.md | 7 +++++--
docs/client-libraries-dotnet-use.md | 1 +
docs/client-libraries-go-initialize.md | 1 +
docs/client-libraries-go-setup.md | 7 +++++--
docs/client-libraries-go-use.md | 1 +
docs/client-libraries-java-initialize.md | 1 +
docs/client-libraries-java-setup.md | 7 +++++--
docs/client-libraries-java-use.md | 1 +
docs/client-libraries-node-configs.md | 1 +
docs/client-libraries-node-initialize.md | 1 +
docs/client-libraries-node-setup.md | 7 +++++--
docs/client-libraries-node-use.md | 1 +
docs/client-libraries-producers.md | 1 +
docs/client-libraries-python-initialize.md | 1 +
docs/client-libraries-python-setup.md | 7 +++++--
docs/client-libraries-python-use.md | 1 +
docs/client-libraries-readers.md | 3 ++-
docs/client-libraries-rest.md | 1 +
docs/client-libraries-schema.md | 1 +
docs/client-libraries-tableviews.md | 1 +
docs/client-libraries-websocket.md | 1 +
docs/client-libraries.md | 1 +
29 files changed, 55 insertions(+), 14 deletions(-)
diff --git a/docs/client-libraries-clients.md b/docs/client-libraries-clients.md
index cdb3be05a6cc..7f41ddfdf6c6 100644
--- a/docs/client-libraries-clients.md
+++ b/docs/client-libraries-clients.md
@@ -2,6 +2,7 @@
id: client-libraries-clients
title: Work with clients
sidebar_label: "Work with clients"
+description: Learn how to work with clients in Pulsar.
---
````mdx-code-block
diff --git a/docs/client-libraries-cluster-level-failover.md
b/docs/client-libraries-cluster-level-failover.md
index e84acc436b00..f63cddc27a90 100644
--- a/docs/client-libraries-cluster-level-failover.md
+++ b/docs/client-libraries-cluster-level-failover.md
@@ -2,6 +2,7 @@
id: client-libraries-cluster-level-failover
title: Configure cluster-level failover
sidebar_label: "Configure cluster-level failover"
+description: Learn how to configure cluster-level failover in Pulsar.
---
````mdx-code-block
@@ -128,7 +129,7 @@ Parameter|Default value|Required?|Description
Here is an example of how `urlProviderHeader` works.
-
+
Assume that you want to connect Pulsar client 1 to cluster A.
diff --git a/docs/client-libraries-consumers.md
b/docs/client-libraries-consumers.md
index 28cfb4c0d5a9..906bf49ad03f 100644
--- a/docs/client-libraries-consumers.md
+++ b/docs/client-libraries-consumers.md
@@ -2,6 +2,7 @@
id: client-libraries-consumers
title: Work with consumer
sidebar_label: "Work with consumer"
+description: Learn how to work with consumers in Pulsar.
---
````mdx-code-block
diff --git a/docs/client-libraries-cpp-initialize.md
b/docs/client-libraries-cpp-initialize.md
index 43e2239f8039..393f149b6858 100644
--- a/docs/client-libraries-cpp-initialize.md
+++ b/docs/client-libraries-cpp-initialize.md
@@ -2,6 +2,7 @@
id: client-libraries-cpp-initialize
title: Initialize a C++ client object
sidebar_label: "Initialize"
+description: Learn how to Initialize C++ client in Pulsar.
---
You can instantiate a Client object using just a URL for the target Pulsar
[cluster](reference-terminology.md#cluster) like this:
diff --git a/docs/client-libraries-cpp-setup.md
b/docs/client-libraries-cpp-setup.md
index beb1c3c1836e..3b6f9f1323d0 100644
--- a/docs/client-libraries-cpp-setup.md
+++ b/docs/client-libraries-cpp-setup.md
@@ -2,9 +2,12 @@
id: client-libraries-cpp-setup
title: Set up Pulsar C++ client
sidebar_label: "Set up"
+description: Learn how to set up C++ client library in Pulsar.
---
-## Install C++ client library
+To set up C++ client library in Pulsar, complete the following steps.
+
+## Step 1: Install C++ client library
Use one of the following methods to install a Pulsar C++ client.
@@ -103,7 +106,7 @@ If you get an error like "libpulsar.so: cannot open shared
object file: No such
apk add --allow-untrusted ./apache-pulsar-client-*.apk
```
-## Connect to Pulsar cluster
+## Step 2: Connect to Pulsar cluster
To connect to Pulsar using client libraries, you need to specify a [Pulsar
protocol](developing-binary-protocol.md) URL.
diff --git a/docs/client-libraries-cpp-use.md b/docs/client-libraries-cpp-use.md
index b3be4bc72e76..9fb0becf9f73 100644
--- a/docs/client-libraries-cpp-use.md
+++ b/docs/client-libraries-cpp-use.md
@@ -2,6 +2,7 @@
id: client-libraries-cpp-use
title: Use C++ client
sidebar_label: "Use"
+description: Learn how to use C++ client in Pulsar.
---
## Create a producer
diff --git a/docs/client-libraries-dotnet-initialize.md
b/docs/client-libraries-dotnet-initialize.md
index 7cafddb88d1b..345295bb327a 100644
--- a/docs/client-libraries-dotnet-initialize.md
+++ b/docs/client-libraries-dotnet-initialize.md
@@ -2,6 +2,7 @@
id: client-libraries-dotnet-initialize
title: Initialize C# client
sidebar_label: "Initialize"
+description: Learn how to initialize C# client in Pulsar.
---
diff --git a/docs/client-libraries-dotnet-setup.md
b/docs/client-libraries-dotnet-setup.md
index be2b4136147d..a9f9ddd5fbf2 100644
--- a/docs/client-libraries-dotnet-setup.md
+++ b/docs/client-libraries-dotnet-setup.md
@@ -2,9 +2,12 @@
id: client-libraries-dotnet-setup
title: Set up C# client
sidebar_label: "Set up"
+description: Learn how to set up C# client library in Pulsar.
---
-## Install C# client library
+To set up C# client library in Pulsar, complete the following steps.
+
+## Step 1: Install C# client library
This section describes how to install the Pulsar C# client library through the
dotnet CLI.
@@ -44,7 +47,7 @@ To install the Pulsar C# client library using the dotnet CLI,
follow these steps
</ItemGroup>
```
-## Connect to Pulsar cluster
+## Step 2: Connect to Pulsar cluster
To connect to Pulsar using client libraries, you need to specify a [Pulsar
protocol](developing-binary-protocol.md) URL.
diff --git a/docs/client-libraries-dotnet-use.md
b/docs/client-libraries-dotnet-use.md
index 6ca08985a4ea..95bcf0f3b300 100644
--- a/docs/client-libraries-dotnet-use.md
+++ b/docs/client-libraries-dotnet-use.md
@@ -2,6 +2,7 @@
id: client-libraries-dotnet-use
title: Use C# client
sidebar_label: "Use"
+description: Learn how to use C# client in Pulsar.
---
This section introduces some hands-on examples to get started with using the
Pulsar C# client.
diff --git a/docs/client-libraries-go-initialize.md
b/docs/client-libraries-go-initialize.md
index 3011c08e6bd8..5958bf508910 100644
--- a/docs/client-libraries-go-initialize.md
+++ b/docs/client-libraries-go-initialize.md
@@ -2,6 +2,7 @@
id: client-libraries-go-initialize
title: Initialize Pulsar Go client
sidebar_label: "Initialize"
+description: Learn how to initialize Go client in Pulsar.
---
To interact with Pulsar, you need a
[`Client`](https://pkg.go.dev/github.com/apache/pulsar-client-go/pulsar#Client)
object first.
diff --git a/docs/client-libraries-go-setup.md
b/docs/client-libraries-go-setup.md
index f496e605088a..6c486c327b64 100644
--- a/docs/client-libraries-go-setup.md
+++ b/docs/client-libraries-go-setup.md
@@ -2,9 +2,12 @@
id: client-libraries-go-setup
title: Set up Pulsar Go client library
sidebar_label: "Set up"
+description: Learn how to set up Go client library in Pulsar.
---
-## Install Go client library
+To set up Go client library in Pulsar, complete the following steps.
+
+## Step 1: Install Go client library
You can install the `pulsar` library by using either `go get` or `go module`.
@@ -39,7 +42,7 @@ You can install the `pulsar` library by using either `go get`
or `go module`.
./test_example
```
-## Connect to Pulsar cluster
+## Step 2: Connect to Pulsar cluster
To connect to Pulsar using client libraries, you need to specify a [Pulsar
protocol](developing-binary-protocol.md) URL.
diff --git a/docs/client-libraries-go-use.md b/docs/client-libraries-go-use.md
index d7f81eaed208..6f87116712bf 100644
--- a/docs/client-libraries-go-use.md
+++ b/docs/client-libraries-go-use.md
@@ -2,6 +2,7 @@
id: client-libraries-go-use
title: Use Pulsar Go client
sidebar_label: "Use"
+description: Learn how to use Go client in Pulsar.
---
diff --git a/docs/client-libraries-java-initialize.md
b/docs/client-libraries-java-initialize.md
index 38ddedd60f47..33a1e8f5d5f2 100644
--- a/docs/client-libraries-java-initialize.md
+++ b/docs/client-libraries-java-initialize.md
@@ -2,6 +2,7 @@
id: client-libraries-java-initialize
title: Initialize a Java client
sidebar_label: "Initialize"
+description: Learn how to initialize Java client in Pulsar.
---
diff --git a/docs/client-libraries-java-setup.md
b/docs/client-libraries-java-setup.md
index c846efe26766..0094deb11e93 100644
--- a/docs/client-libraries-java-setup.md
+++ b/docs/client-libraries-java-setup.md
@@ -2,9 +2,12 @@
id: client-libraries-java-setup
title: Set up Java client
sidebar_label: "Set up"
+description: Learn how to set up Java client library in Pulsar.
---
-## Install Java client library
+To set up Java client in Pulsar, complete the following steps.
+
+## Step 1: Install Java client library
The latest version of the Pulsar Java client library is available via [Maven
Central](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C@pulsar:version@%7Cjar).
To use the latest version, add the `pulsar-client` library to your build
configuration.
@@ -43,7 +46,7 @@ dependencies {
}
```
-## Connect to Pulsar cluster
+## Step 2: Connect to Pulsar cluster
To connect to Pulsar using client libraries, you need to specify a [Pulsar
protocol](developing-binary-protocol.md) URL.
diff --git a/docs/client-libraries-java-use.md
b/docs/client-libraries-java-use.md
index 1d9fea6e0fa0..9d692e508dfa 100644
--- a/docs/client-libraries-java-use.md
+++ b/docs/client-libraries-java-use.md
@@ -2,6 +2,7 @@
id: client-libraries-java-use
title: Use a Java client
sidebar_label: "Use"
+description: Learn how to use Java client in Pulsar.
---
## Create a producer
diff --git a/docs/client-libraries-node-configs.md
b/docs/client-libraries-node-configs.md
index 96a69e195425..a09aa1583ef1 100644
--- a/docs/client-libraries-node-configs.md
+++ b/docs/client-libraries-node-configs.md
@@ -2,6 +2,7 @@
id: client-libraries-node-configs
title: Pulsar Node.js client configurations
sidebar_label: "Configs"
+description: Get a comprehensive understanding of configurable parameters for
Pulsar Node.js clients.
---
diff --git a/docs/client-libraries-node-initialize.md
b/docs/client-libraries-node-initialize.md
index 0a8ab5ba2a97..4ab38258c63c 100644
--- a/docs/client-libraries-node-initialize.md
+++ b/docs/client-libraries-node-initialize.md
@@ -2,6 +2,7 @@
id: client-libraries-node-initialize
title: Initialize Node.js client
sidebar_label: "Initialize"
+description: Learn how to initialize Node.js client in Pulsar.
---
diff --git a/docs/client-libraries-node-setup.md
b/docs/client-libraries-node-setup.md
index a81fe5f3afca..a3686e7b43ef 100644
--- a/docs/client-libraries-node-setup.md
+++ b/docs/client-libraries-node-setup.md
@@ -2,9 +2,12 @@
id: client-libraries-node-setup
title: Set up Pulsar Node.js client
sidebar_label: "Set up"
+description: Learn how to set up Node.js client library in Pulsar.
---
-## Install Node.js client library
+To set up Java client library in Pulsar, complete the following steps.
+
+## Step 1: Install Node.js client library
Install the [`pulsar-client`](https://www.npmjs.com/package/pulsar-client)
library via [npm](https://www.npmjs.com/):
@@ -20,7 +23,7 @@ This library only works in Node.js 10.x or later versions
because it uses the [`
:::
-## Connect to Pulsar cluster
+## Step 2: Connect to Pulsar cluster
To connect to Pulsar using client libraries, you need to specify a [Pulsar
protocol](developing-binary-protocol.md) URL.
diff --git a/docs/client-libraries-node-use.md
b/docs/client-libraries-node-use.md
index 4f5322e54b02..1476230e40a5 100644
--- a/docs/client-libraries-node-use.md
+++ b/docs/client-libraries-node-use.md
@@ -2,6 +2,7 @@
id: client-libraries-node-use
title: Usee Node.js client
sidebar_label: "Use"
+description: Learn how to use Node.js client in Pulsar.
---
## Create a producer
diff --git a/docs/client-libraries-producers.md
b/docs/client-libraries-producers.md
index afaae7fa29eb..98e6fa0fb701 100644
--- a/docs/client-libraries-producers.md
+++ b/docs/client-libraries-producers.md
@@ -2,6 +2,7 @@
id: client-libraries-producers
title: Work with producer
sidebar_label: "Work with producer"
+description: Learn how to work with producers in Pulsar.
---
````mdx-code-block
diff --git a/docs/client-libraries-python-initialize.md
b/docs/client-libraries-python-initialize.md
index 5679cffe0e7e..6c60252b5669 100644
--- a/docs/client-libraries-python-initialize.md
+++ b/docs/client-libraries-python-initialize.md
@@ -2,6 +2,7 @@
id: client-libraries-python-initialize
title: Initialize Python client
sidebar_label: "Initialize"
+description: Learn how to initialize Python client in Pulsar.
---
You can instantiate a Client object using just a URL for the target Pulsar
[cluster](reference-terminology.md#cluster) like this:
diff --git a/docs/client-libraries-python-setup.md
b/docs/client-libraries-python-setup.md
index 53d95afc5b91..245bbcead5f9 100644
--- a/docs/client-libraries-python-setup.md
+++ b/docs/client-libraries-python-setup.md
@@ -2,9 +2,12 @@
id: client-libraries-python-setup
title: Set up Python client
sidebar_label: "Set up"
+description: Learn how to set up Python client library in Pulsar.
---
-## Install Python client library
+To set up Python client library in Pulsar, complete the following steps.
+
+## Step 1: Install Python client library
Use [pip](https://pip.pypa.io/) to install the latest version:
@@ -32,7 +35,7 @@ Installation via PyPi is available for the following Python
versions:
| macOS (>= 11.0) | 3.7, 3.8, 3.9 and 3.10 |
| Linux (including Alpine Linux) | 3.7, 3.8, 3.9 and 3.10 |
-## Connect to Pulsar cluster
+## Step 2: Connect to Pulsar cluster
To connect to Pulsar using client libraries, you need to specify a [Pulsar
protocol](developing-binary-protocol.md) URL.
diff --git a/docs/client-libraries-python-use.md
b/docs/client-libraries-python-use.md
index a9b716bd9fe7..abe6534542e2 100644
--- a/docs/client-libraries-python-use.md
+++ b/docs/client-libraries-python-use.md
@@ -2,6 +2,7 @@
id: client-libraries-python-use
title: Use Python client
sidebar_label: "Use"
+description: Learn how to use Python client in Pulsar.
---
## Create a producer
diff --git a/docs/client-libraries-readers.md b/docs/client-libraries-readers.md
index ed2c69d63a04..f7ecd50f0b2b 100644
--- a/docs/client-libraries-readers.md
+++ b/docs/client-libraries-readers.md
@@ -2,6 +2,7 @@
id: client-libraries-readers
title: Work with reader
sidebar_label: "Work with reader"
+description: Learn how to work with readers in Pulsar.
---
````mdx-code-block
@@ -249,7 +250,7 @@ Reader<byte[]> reader = pulsarClient.newReader()
Pulsar reader interceptor intercepts and possibly mutates messages with
user-defined processing before [Pulsar
reader](concepts-clients.md#reader-interface) reads them. With reader
interceptors, you can apply unified messaging processes before messages can be
read, such as modifying messages, adding properties, collecting statistics and
etc, without creating similar mechanisms respectively.
-
+
Pulsar reader interceptor works on top of Pulsar consumer interceptor. The
plugin interface `ReaderInterceptor` can be treated as a subset of
`ConsumerInterceptor` and it has two main events.
* `beforeRead` is triggered before readers read messages. You can modify
messages within this event.
diff --git a/docs/client-libraries-rest.md b/docs/client-libraries-rest.md
index c754ccacc154..3225331dc2de 100644
--- a/docs/client-libraries-rest.md
+++ b/docs/client-libraries-rest.md
@@ -2,6 +2,7 @@
id: client-libraries-rest
title: Pulsar REST
sidebar_label: "REST"
+description: Learn how to use Pulsar REST to interact with Pulsar without
using client libraries.
---
Pulsar not only provides REST endpoints to manage resources in Pulsar
clusters, but also provides methods to query the state for those resources. In
addition, Pulsar REST provides a simple way to interact with Pulsar **without
using client libraries**, which is convenient for applications to use HTTP to
interact with Pulsar.
diff --git a/docs/client-libraries-schema.md b/docs/client-libraries-schema.md
index bf080e5f7b7c..be5c2a2a2e39 100644
--- a/docs/client-libraries-schema.md
+++ b/docs/client-libraries-schema.md
@@ -2,6 +2,7 @@
id: client-libraries-schema
title: Work with schema
sidebar_label: "Work with schema"
+description: Learn how to work with Pyhton schema in Pulsar.
---
diff --git a/docs/client-libraries-tableviews.md
b/docs/client-libraries-tableviews.md
index 6fa32e31081d..f48c57a12f13 100644
--- a/docs/client-libraries-tableviews.md
+++ b/docs/client-libraries-tableviews.md
@@ -2,6 +2,7 @@
id: client-libraries-tableviews
title: Work with TableView
sidebar_label: "Work with TableView"
+description: Learn how to work with TableView in Pulsar.
---
````mdx-code-block
diff --git a/docs/client-libraries-websocket.md
b/docs/client-libraries-websocket.md
index f02da082099f..b927af832e99 100644
--- a/docs/client-libraries-websocket.md
+++ b/docs/client-libraries-websocket.md
@@ -2,6 +2,7 @@
id: client-libraries-websocket
title: Pulsar WebSocket API
sidebar_label: "WebSocket"
+description: Learn how to use Pulsar WebSocket API to interact with Pulsar
using languages that do not have an official client library.
---
Pulsar
[WebSocket](https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API)
API provides a simple way to interact with Pulsar using languages that do not
have an official [client library](client-libraries.md). You can use Pulsar
WebSocket API with any WebSocket client library. See [Python and Node.js
examples](#client-examples) for more details.
diff --git a/docs/client-libraries.md b/docs/client-libraries.md
index 403106b0938a..d56b20042ad1 100644
--- a/docs/client-libraries.md
+++ b/docs/client-libraries.md
@@ -2,6 +2,7 @@
id: client-libraries
title: Pulsar client libraries
sidebar_label: "Overview"
+description: Get a comprehensive understanding of Pulsar client libraries.
---
## Language-specific client libraries
