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/08/21 13:43:17 UTC
[GitHub] [pulsar] SignorMercurio opened a new pull request, #17198: [feature][doc] Generate client config docs from source code
SignorMercurio opened a new pull request, #17198:
URL: https://github.com/apache/pulsar/pull/17198
Master issue: #14184
### Motivation
Please checkout the master issue.
### Modifications
Add some docs annotations to `Client`, `Producer`, `Consumer` and `Reader` with the data sourcing from the configuration table from [Pulsar Java Client Docs](https://pulsar.apache.org/docs/next/client-libraries-java), so that their config docs can be auto-generated. The code to auto-generate these are also added in this PR.
### Verifying this change
- [x] Make sure that the change passes the CI checks.
This change is a trivial rework / code cleanup without any test coverage.
### Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API: no
- The schema: no
- The default values of configurations: no
- The wire protocol: no
- The rest endpoints: no
- The admin cli options: no
- Anything that affects deployment: no
### Documentation
Check the box below or label this PR directly.
Need to update docs?
- [ ] `doc-required`
(Your PR needs to update docs and you will update later)
- [x] `doc-not-needed`
(Please explain why)
This PR is about docs generation only.
- [] `doc`
(Your PR contains doc changes)
- [ ] `doc-complete`
(Docs have been already added)
--
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] nicoloboschi commented on pull request #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
nicoloboschi commented on PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#issuecomment-1259270657
@SignorMercurio we must not add new dependencies to pulsar-client, especially pulsar-broker internal modules.
we can move [pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java](https://github.com/apache/pulsar/pull/17198/files#diff-6d4deed273c647ddf14385ae9f883834e94a2d411268be4ebec7b026b064a193) to the `pulsar-common` module in order to remove the need of `pulsar-broker-common` dependency in the pulsar-client
--
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] urfreespace commented on a diff in pull request #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
urfreespace commented on code in PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#discussion_r954516964
##########
pulsar-client/pom.xml:
##########
@@ -182,6 +182,12 @@
<artifactId>awaitility</artifactId>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.pulsar</groupId>
+ <artifactId>pulsar-broker-common</artifactId>
+ <version>2.11.0-SNAPSHOT</version>
Review Comment:
I think we should use variables here, but not a specific version `2.11.0-SNAPSHOT`
--
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 #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#issuecomment-1229695061
@Technoboy- Could you please review this PR from the technical perspective?
Thank you! 😊
--
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] SignorMercurio commented on a diff in pull request #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on code in PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#discussion_r954519348
##########
pulsar-client/pom.xml:
##########
@@ -182,6 +182,12 @@
<artifactId>awaitility</artifactId>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.pulsar</groupId>
+ <artifactId>pulsar-broker-common</artifactId>
+ <version>2.11.0-SNAPSHOT</version>
Review Comment:
Do you mean `${project.parent.version}`?
I find this modification is auto performed by the IDE. I changed the version as well as the location of the dependency in the file.
--
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 #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #17198:
URL: https://github.com/apache/pulsar/pull/17198
--
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] urfreespace commented on a diff in pull request #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
urfreespace commented on code in PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#discussion_r956855426
##########
pulsar-client/pom.xml:
##########
@@ -182,6 +182,12 @@
<artifactId>awaitility</artifactId>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.pulsar</groupId>
+ <artifactId>pulsar-broker-common</artifactId>
+ <version>2.11.0-SNAPSHOT</version>
Review Comment:
OK, I see now
--
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] SignorMercurio commented on pull request #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#issuecomment-1260272398
@nicoloboschi Thank you for pointing this out and fixing this!
--
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 #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#issuecomment-1226745201
@urfreespace
Could you please review this PR from the technical perspective?
Thank you! 😊
--
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] SignorMercurio commented on a diff in pull request #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on code in PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#discussion_r954519348
##########
pulsar-client/pom.xml:
##########
@@ -182,6 +182,12 @@
<artifactId>awaitility</artifactId>
<scope>test</scope>
</dependency>
+ <dependency>
+ <groupId>org.apache.pulsar</groupId>
+ <artifactId>pulsar-broker-common</artifactId>
+ <version>2.11.0-SNAPSHOT</version>
Review Comment:
Do you mean `${project.parent.version}`?
--
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] SignorMercurio commented on pull request #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#issuecomment-1237677375
@Anonymitaet I've updated with the master branch. I think there's currently no conflict.
--
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 #17198: [feature][doc] Generate client config docs from source code
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #17198:
URL: https://github.com/apache/pulsar/pull/17198#issuecomment-1237639921
@SignorMercurio can you resolve conflicts? Then we can merge this
--
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