You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/03/07 09:09:22 UTC
[GitHub] [pulsar] Anonymitaet opened a new pull request #14577: [Doc] add explanations for Java client library
Anonymitaet opened a new pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577
Fix https://github.com/apache/pulsar/issues/14571
Preview looks good:
<img width="1169" alt="image" src="https://user-images.githubusercontent.com/50226895/157000611-4d33cf7a-0c04-475f-b7f9-0152480d6e88.png">
Thanks @BewareMyPower for your clear and helpful guidance!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #14577: [Doc] add explanations for Java client library
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577#issuecomment-1060367091
@BewareMyPower @codelipenghui @momo-jun could you please help review? Thanks
@polyzos FYI
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] RobertIndie commented on a change in pull request #14577: [Doc] add explanations for Java client library
Posted by GitBox <gi...@apache.org>.
RobertIndie commented on a change in pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577#discussion_r821280107
##########
File path: site2/docs/client-libraries-java.md
##########
@@ -22,6 +22,11 @@ This document focuses only on the client API for producing and consuming message
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.
+> **Tip**
+>
+> - [`pulsar-client`](https://search.maven.org/artifact/org.apache.pulsar/pulsar-client) and [`pulsar-client-admin`](https://search.maven.org/artifact/org.apache.pulsar/pulsar-client-admin) shade dependencies. If you do not want to manage dependency conflicts, you can use them.
+>
+> - [`pulsar-client-original`](https://search.maven.org/artifact/org.apache.pulsar/pulsar-client-original) and [`pulsar-client-admin-original`](https://search.maven.org/artifact/org.apache.pulsar/pulsar-client-admin-original) **does not** shade dependencies. If you want to manage dependencies, you can use them.
Review comment:
```suggestion
> - [`pulsar-client-original`](https://search.maven.org/artifact/org.apache.pulsar/pulsar-client-original) and [`pulsar-client-admin-original`](https://search.maven.org/artifact/org.apache.pulsar/pulsar-client-admin-original) **does not** shade dependencies. If you want to manage dependency conflicts manually, you can use them.
```
This seems more accurate.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tuteng commented on pull request #14577: [Doc] add explanations for Java client library
Posted by GitBox <gi...@apache.org>.
tuteng commented on pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577#issuecomment-1061759024
It seems that we don't need to add a milestone to document, because it will be automatically published after it is merged into master
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet merged pull request #14577: [Doc] add explanations for Java client library
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #14577: [Doc] add explanations for Java client library
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577#issuecomment-1061504536
@BewareMyPower @RobertIndie many thanks for your guidance! I've incorporated your comments. PTAL.
(@BewareMyPower I only add explanations for the 1st "shade dependency" and do not add those for the 2nd one. Users shall know the meaning since we already add explanations for the 1st one, to reduce redundancy, that's enough)
<img width="646" alt="image" src="https://user-images.githubusercontent.com/50226895/157192165-9b0f35d5-9e63-4b63-94e4-c9aea51bc691.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] dave2wave commented on a change in pull request #14577: [Doc] add explanations for Java client library
Posted by GitBox <gi...@apache.org>.
dave2wave commented on a change in pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577#discussion_r822861570
##########
File path: site2/docs/client-libraries-java.md
##########
@@ -12,7 +12,7 @@ Javadoc for the Pulsar client is divided into two domains by package as follows.
Package | Description | Maven Artifact
:-------|:------------|:--------------
-[`org.apache.pulsar.client.api`](/api/client) | The producer and consumer API | [org.apache.pulsar:pulsar-client:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C{{pulsar:version}}%7Cjar)
+[`org.apache.pulsar.client.api`](/api/client) | [The producer and consumer API](https://pulsar.apache.org/api/client/) | [org.apache.pulsar:pulsar-client:{{pulsar:version}}](http://search.maven.org/#artifactdetails%7Corg.apache.pulsar%7Cpulsar-client%7C{{pulsar:version}}%7Cjar)
Review comment:
It would be best for links from pages within the website domain to be `/api/client/` and leave out `https://pulsar.apache.org`. If you do that then you can easily test the links on staged websites!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] BewareMyPower commented on a change in pull request #14577: [Doc] add explanations for Java client library
Posted by GitBox <gi...@apache.org>.
BewareMyPower commented on a change in pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577#discussion_r820517904
##########
File path: site2/docs/client-libraries-java.md
##########
@@ -22,6 +22,11 @@ This document focuses only on the client API for producing and consuming message
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.
+> **Tip**
+>
+> - [`pulsar-client`](https://search.maven.org/artifact/org.apache.pulsar/pulsar-client) and [`pulsar-client-admin`](https://search.maven.org/artifact/org.apache.pulsar/pulsar-client-admin) shade dependencies. If you do not want to manage dependency conflicts, you can use them.
Review comment:
The term `shade dependencies` here is too simple and might make users confused.
My suggested change is:
> ... shade dependencies via [maven-shade-plugin](https://maven.apache.org/plugins/maven-shade-plugin/) to avoid conflicts of the underlying dependency packages like Netty.
BTW, here is a blog about how the Maven shade plugin solves the dependency conflicts: https://developpaper.com/using-maven-shade-plugin-to-solve-incompatible-dependency-conflicts/
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #14577: [Doc] add explanations for Java client library
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on pull request #14577:
URL: https://github.com/apache/pulsar/pull/14577#issuecomment-1062487469
@tuteng I add milestones for doc PRs because we want to get doc related statistics for each release.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org