Skip to content

Conversation

@tisonkun
Copy link
Member

@tisonkun tisonkun commented Aug 9, 2022

Related to apache/pulsar-site#146.

Motivation

  • Websocket is not a language but a language-agnostic interface.

Modifications

  1. Separate language-specific and language-agnostic clients.
  2. Improve third-party client libraries display - show stars, grouped by languages.
  3. Avoid redundant links to doc tools, it's not what users care.

Preview

image

image

Documentation

  • doc

cc @Anonymitaet @momo-jun @shibd @RobertIndie

Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Comment on lines -19 to -23
:::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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This note is included as "bundled" or "standalone".

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggest keeping lines 21-22. Reasons:

  1. It's more clear to show users the whole information (lines 21-22), especially for those who are not familiar with Pulsar.

  2. Some users can not fully understand the meaning of standalone and bundled because they can represent other meanings as well, or at least, they can not understand it at first glance and need to take a little more time to do the guesswork.

🔹🔹🔹

So how about compromising it as:

  • Keep standalone and bundled in tables
  • Also keep the whole explanation (lines 21 -22)

In this way, there is no redundant, missing, or confusing info.

Copy link
Member Author

@tisonkun tisonkun Aug 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also keep the whole explanation (lines 21 -22)

Concise is important to document. We don't have to write down all information.

Users don't think of what the word means at first but click the link, and the "standalone" result doesn't confuse. While the "bundled" result is explained by its result - it's bundled with the main repo / main release.

Copy link
Member Author

@tisonkun tisonkun Aug 10, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In another word, users don't care about how we organize release note and codebase, if only the link directs to the right place/result.

Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
@tisonkun tisonkun requested a review from RobertIndie August 10, 2022 02:23
Signed-off-by: tison <wander4096@gmail.com>
@tisonkun tisonkun requested a review from Anonymitaet August 11, 2022 03:50
@RobertIndie RobertIndie merged commit 13cea5c into apache:master Aug 11, 2022
@tisonkun tisonkun deleted the client-libraries branch August 11, 2022 09:19
coderzc pushed a commit to coderzc/pulsar that referenced this pull request Aug 13, 2022
…ts (apache#17010)

Related to apache/pulsar-site#146.

### Motivation

* Websocket is not a language but a language-agnostic interface.

### Modifications

1. Separate language-specific and language-agnostic clients.
2. Improve third-party client libraries display - show stars, grouped by languages.
3. Avoid redundant links to doc tools, it's not what users care.

Signed-off-by: tison <wander4096@gmail.com>
Technoboy- pushed a commit to merlimat/pulsar that referenced this pull request Aug 16, 2022
…ts (apache#17010)

Related to apache/pulsar-site#146.

### Motivation

* Websocket is not a language but a language-agnostic interface.

### Modifications

1. Separate language-specific and language-agnostic clients.
2. Improve third-party client libraries display - show stars, grouped by languages.
3. Avoid redundant links to doc tools, it's not what users care.

Signed-off-by: tison <wander4096@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants