-
Notifications
You must be signed in to change notification settings - Fork 3.7k
[improve][doc] Separate language-specific and language-agnostic clients #17010
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
Signed-off-by: tison <wander4096@gmail.com>
| :::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. | ||
|
|
There was a problem hiding this comment.
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".
There was a problem hiding this comment.
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:
-
It's more clear to show users the whole information (lines 21-22), especially for those who are not familiar with Pulsar.
-
Some users can not fully understand the meaning of
standaloneandbundledbecause 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
standaloneandbundledin tables - Also keep the whole explanation (lines 21 -22)
In this way, there is no redundant, missing, or confusing info.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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>
Signed-off-by: tison <wander4096@gmail.com>
…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>
…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>
Related to apache/pulsar-site#146.
Motivation
Modifications
Preview
Documentation
doccc @Anonymitaet @momo-jun @shibd @RobertIndie