You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by ur...@apache.org on 2022/08/11 12:01:44 UTC
[pulsar-site] branch main updated: Docs sync done from apache/pulsar(#13cea5c)
This is an automated email from the ASF dual-hosted git repository.
urfree 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 4917499a996 Docs sync done from apache/pulsar(#13cea5c)
4917499a996 is described below
commit 4917499a9965c4d66bea630f9619651d30f2ef06
Author: Pulsar Site Updater <de...@pulsar.apache.org>
AuthorDate: Thu Aug 11 12:01:38 2022 +0000
Docs sync done from apache/pulsar(#13cea5c)
---
site2/website-next/docs/client-libraries-cpp.md | 3 +-
site2/website-next/docs/client-libraries-python.md | 2 +-
site2/website-next/docs/client-libraries.md | 88 +++++++++++++++-------
3 files changed, 62 insertions(+), 31 deletions(-)
diff --git a/site2/website-next/docs/client-libraries-cpp.md b/site2/website-next/docs/client-libraries-cpp.md
index b709463ff03..235af0804bf 100644
--- a/site2/website-next/docs/client-libraries-cpp.md
+++ b/site2/website-next/docs/client-libraries-cpp.md
@@ -12,8 +12,7 @@ All the methods in producer, consumer, and reader of a C++ client are thread-saf
Pulsar C++ client is supported on **Linux** ,**MacOS** and **Windows** platforms.
-[Doxygen](http://www.doxygen.nl/)-generated API docs for the C++ client are available [here](/api/cpp).
-
+Doxygen-generated API docs for the C++ client are available [here](/api/cpp).
## Linux
diff --git a/site2/website-next/docs/client-libraries-python.md b/site2/website-next/docs/client-libraries-python.md
index 11aa73d590e..e5b11345de2 100644
--- a/site2/website-next/docs/client-libraries-python.md
+++ b/site2/website-next/docs/client-libraries-python.md
@@ -14,7 +14,7 @@ Pulsar Python client library is a wrapper over the existing [C++ client library]
All the methods in producer, consumer, and reader of a Python client are thread-safe.
-[pdoc](https://github.com/BurntSushi/pdoc)-generated API docs for the Python client are available [here](/api/python).
+pdoc-generated API docs for the Python client are available [here](/api/python).
## Install
diff --git a/site2/website-next/docs/client-libraries.md b/site2/website-next/docs/client-libraries.md
index 9a48d8801f0..93a61cdaebc 100644
--- a/site2/website-next/docs/client-libraries.md
+++ b/site2/website-next/docs/client-libraries.md
@@ -4,42 +4,74 @@ title: Pulsar client libraries
sidebar_label: "Overview"
---
-Pulsar supports the following client libraries:
+Pulsar supports the following language specific client libraries:
-| Language | Documentation | Release note | Code repo |
-|-----------|-------------------------------------------------------------------------------|--------------------------------------------------------------------------|-------------------------------------------------------------------------------|
-| Java | - [User doc](client-libraries-java.md) <br/><br/> - [API doc](/api/client/) | [Here](/release-notes/) | [Here](https://github.com/apache/pulsar/tree/master/pulsar-client) |
-| C++ | - [User doc](client-libraries-cpp.md) <br/><br/> - [API doc](/api/cpp/) | [Here](/release-notes/) | [Here](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp) |
-| Python | - [User doc](client-libraries-python.md) <br/><br/> - [API doc](/api/python/) | [Here](/release-notes/) | [Here](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) |
-| WebSocket | [User doc](client-libraries-websocket.md) | [Here](/release-notes/) | [Here](https://github.com/apache/pulsar/tree/master/pulsar-websocket) |
-| Go client | [User doc](client-libraries-go.md) | [Here](https://github.com/apache/pulsar-client-go/blob/master/CHANGELOG) | [Here](https://github.com/apache/pulsar-client-go) |
-| Node.js | [User doc](client-libraries-node.md) | [Here](https://github.com/apache/pulsar-client-node/releases) | [Here](https://github.com/apache/pulsar-client-node) |
-| C# | [User doc](client-libraries-dotnet.md) | [Here](https://github.com/apache/pulsar-dotpulsar/blob/master/CHANGELOG) | [Here](https://github.com/apache/pulsar-dotpulsar) |
+| Language | Documentation | Release note | Code repo |
+| --------- | -------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
+| Java | [User doc](client-libraries-java.md) <br/> [API doc](/api/client/) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-client) |
+| C++ | [User doc](client-libraries-cpp.md) <br/> [API doc](/api/cpp/) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp) |
+| Python | [User doc](client-libraries-python.md) <br/> [API doc](/api/python/) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-client-cpp/python) |
+| Go client | [User doc](client-libraries-go.md) | [Standalone](https://github.com/apache/pulsar-client-go/releases) | [Standalone](https://github.com/apache/pulsar-client-go) |
+| Node.js | [User doc](client-libraries-node.md) | [Standalone](https://github.com/apache/pulsar-client-node/releases) | [Standalone](https://github.com/apache/pulsar-client-node) |
+| C# | [User doc](client-libraries-dotnet.md) | [Standalone](https://github.com/apache/pulsar-dotpulsar/blob/master/CHANGELOG.md) | [Standalone](https://github.com/apache/pulsar-dotpulsar) |
-:::note
+Pulsar supports the following language-agnostic client libraries:
-- The code repos of **Java, C++, Python,** and **WebSocket** clients are hosted in the [Pulsar main repo](https://github.com/apache/pulsar) and these clients are released with Pulsar, so their release notes are parts of [Pulsar release note](/release-notes/).
-- The code repos of **Go, Node.js,** and **C#** clients are hosted outside of the [Pulsar main repo](https://github.com/apache/pulsar) and these clients are not released with Pulsar, so they have independent release notes.
-
-:::
+| Interface | Documentation | Release note | Code repo |
+| --------- | ----------------------------------------- | -------------------------- | ------------------------------------------------------------------------ |
+| REST | [User doc](client-libraries-rest.md) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-broker) |
+| WebSocket | [User doc](client-libraries-websocket.md) | [Bundled](/release-notes/) | [Bundled](https://github.com/apache/pulsar/tree/master/pulsar-websocket) |
## Feature matrix
+
Pulsar client feature matrix for different languages is listed on [Pulsar Feature Matrix (Client and Function)](https://docs.google.com/spreadsheets/d/1YHYTkIXR8-Ql103u-IMI18TXLlGStK8uJjDsOOA0T20/edit#gid=1784579914) page.
## Third-party clients
Besides the official released clients, multiple projects on developing Pulsar clients are available in different languages.
-> If you have developed a new Pulsar client, feel free to submit a pull request and add your client to the list below.
-
-| Language | Project | Maintainer | License | Description |
-|----------|---------|------------|---------|-------------|
-| Go | [pulsar-client-go](https://github.com/Comcast/pulsar-client-go) | [Comcast](https://github.com/Comcast) | [](https://opensource.org/licenses/Apache-2.0) | A native golang client |
-| Go | [go-pulsar](https://github.com/t2y/go-pulsar) | [t2y](https://github.com/t2y) | [](https://opensource.org/licenses/Apache-2.0) |
-| Haskell | [supernova](https://github.com/cr-org/supernova) | [Chatroulette](https://github.com/cr-org) | [](https://opensource.org/licenses/Apache-2.0) | Native Pulsar client for Haskell |
-| Scala | [neutron](https://github.com/cr-org/neutron) | [Chatroulette](https://github.com/cr-org) | [](https://opensource.org/licenses/Apache-2.0) | Purely functional Apache Pulsar client for Scala built on top of Fs2 |
-| Scala | [pulsar4s](https://github.com/sksamuel/pulsar4s) | [sksamuel](https://github.com/sksamuel) | [](https://opensource.org/licenses/Apache-2.0) | Idomatic, typesafe, and reactive Scala client for Apache Pulsar |
-| Rust | [pulsar-rs](https://github.com/wyyerd/pulsar-rs) | [Wyyerd Group](https://github.com/wyyerd) | [](https://opensource.org/licenses/Apache-2.0) | Future-based Rust bindings for Apache Pulsar |
-| .NET | [pulsar-client-dotnet](https://github.com/fsharplang-ru/pulsar-client-dotnet) | [Lanayx](https://github.com/Lanayx) | [](https://opensource.org/licenses/MIT) | Native .NET client for C#/F#/VB |
-| Node.js | [pulsar-flex](https://github.com/ayeo-flex-org/pulsar-flex) | [Daniel Sinai](https://github.com/danielsinai), [Ron Farkash](https://github.com/ronfarkash), [Gal Rosenberg](https://github.com/galrose)| [](https://opensource.org/licenses/MIT) | Native Nodejs client |
-| PHP | [pulsar-client-php](https://github.com/ikilobyte/pulsar-client-php) | [ikilobyte](https://github.com/ikilobyte) | [](https://opensource.org/licenses/MIT) | Native PHP client |
+> Want your repository listed here? Just submit a PR to the [pulsar repository](https://github.com/apache/pulsar/edit/master/site2/docs/client-libraries.md).
+
+### .NET
+
+| Project | Description | License | Star |
+| -------------------------------------------------------------------------- | ----------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
+| [pulsar-client-dotnet](https://github.com/fsprojects/pulsar-client-dotnet) | Apache Pulsar native client for .NET (C#/F#/VB) | [MIT](https://opensource.org/licenses/MIT) |  |
+
+### Go
+
+| Project | Description | License | Star |
+| --------------------------------------------------------------- | ---------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
+| [pulsar-client-go](https://github.com/Comcast/pulsar-client-go) | A Go client library for Apache Pulsar | [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) |  |
+| [go-pulsar](https://github.com/t2y/go-pulsar) | go-pulsar is a client library for Pulsar | [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) |  |
+
+### Haskell
+
+| Project | Description | License | Star |
+| ------------------------------------------------ | -------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
+| [supernova](https://github.com/cr-org/supernova) | Apache Pulsar client for Haskell | [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) |  |
+
+### Node.js
+
+| Project | Description | License | Star |
+| ----------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
+| [pulsar-flex](https://github.com/ayeo-flex-org/pulsar-flex) | Pulsar Flex is a modern Apache Pulsar client for Node.js, developed to be independent of C++. | [MIT](https://opensource.org/licenses/MIT) |  |
+
+### PHP
+
+| Project | Description | License | Star |
+| ------------------------------------------------------------------- | ------------------------------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
+| [pulsar-client-php](https://github.com/ikilobyte/pulsar-client-php) | PHP Native Client library for Apache Pulsar | [MIT](https://opensource.org/licenses/MIT) |  |
+
+### Rust
+
+| Project | Description | License | Star |
+| ------------------------------------------------------ | ------------------------------------- | --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
+| [pulsar-rs](https://github.com/streamnative/pulsar-rs) | Rust Client library for Apache Pulsar | [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) |  |
+
+### Scala
+
+| Project | Description | License | Star |
+| --------------------------------------------------- | -------------------------------------------------------------------- | --------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
+| [pulsar4s](https://github.com/CleverCloud/pulsar4s) | Idiomatic, typesafe, and reactive Scala client for Apache Pulsar | [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) |  |
+| [neutron](https://github.com/cr-org/neutron) | Purely functional Apache Pulsar client for Scala built on top of Fs2 | [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0) |  |