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/11/15 10:40:30 UTC
[GitHub] [pulsar] tisonkun opened a new pull request, #18477: [improve][doc] Specially handle Python and C++ API documents
tisonkun opened a new pull request, #18477:
URL: https://github.com/apache/pulsar/pull/18477
This is the counterpart of https://github.com/apache/pulsar-site/pull/291.
Now they have their own repository and release cycle, it's impossible to infer the proper version from the current Pulsar version. We should instead hardcode the corresponding versions for new versions.
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [x] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `sh start.sh` at `pulsar/site2/website`) to your PR description, or else your PR might not get merged. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
### Matching PR in forked repository
PR in forked repository: <!-- ENTER URL HERE -->
<!--
After opening this PR, the build in apache/pulsar will fail and instructions will
be provided for opening a PR in the PR author's forked repository.
apache/pulsar pull requests should be first tested in your own fork since the
apache/pulsar CI based on GitHub Actions has constrained resources and quota.
GitHub Actions provides separate quota for pull requests that are executed in
a forked repository.
The tests will be run in the forked repository until all PR review comments have
been handled, the tests pass and the PR is approved by a reviewer.
-->
--
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] tisonkun commented on pull request #18477: [improve][doc] Specially handle Python and C++ API documents
Posted by GitBox <gi...@apache.org>.
tisonkun commented on PR #18477:
URL: https://github.com/apache/pulsar/pull/18477#issuecomment-1315576424
Verified the replace logics locally. Merging...
--
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] tisonkun merged pull request #18477: [improve][doc] Specially handle Python and C++ API documents
Posted by GitBox <gi...@apache.org>.
tisonkun merged PR #18477:
URL: https://github.com/apache/pulsar/pull/18477
--
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] momo-jun commented on a diff in pull request #18477: [improve][doc] Specially handle Python and C++ API documents
Posted by GitBox <gi...@apache.org>.
momo-jun commented on code in PR #18477:
URL: https://github.com/apache/pulsar/pull/18477#discussion_r1023450945
##########
site2/docs/client-libraries.md:
##########
@@ -6,14 +6,14 @@ sidebar_label: "Overview"
Pulsar supports the following language-specific client libraries:
-| 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/) | [Standalone](https://github.com/apache/pulsar/pulsar-client-cpp) |
-| Python | [User doc](client-libraries-python.md) <br/> [API doc](/api/python/) | [Bundled](/release-notes/) | [Standalone](https://github.com/apache/pulsar-client-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) |
+| 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/3.0.0) | [Bundled](/release-notes/) | [Standalone](https://github.com/apache/pulsar/pulsar-client-cpp) |
Review Comment:
@tison may I know why the latest version number is hard-coded here for C++ API docs while `@pulsar:apidoc:cpp@` is used in other occurrences?
--
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] tisonkun commented on a diff in pull request #18477: [improve][doc] Specially handle Python and C++ API documents
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #18477:
URL: https://github.com/apache/pulsar/pull/18477#discussion_r1023458607
##########
site2/docs/client-libraries.md:
##########
@@ -6,14 +6,14 @@ sidebar_label: "Overview"
Pulsar supports the following language-specific client libraries:
-| 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/) | [Standalone](https://github.com/apache/pulsar/pulsar-client-cpp) |
-| Python | [User doc](client-libraries-python.md) <br/> [API doc](/api/python/) | [Bundled](/release-notes/) | [Standalone](https://github.com/apache/pulsar-client-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) |
+| 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/3.0.0) | [Bundled](/release-notes/) | [Standalone](https://github.com/apache/pulsar/pulsar-client-cpp) |
Review Comment:
See the description at https://github.com/apache/pulsar-site/pull/291.
> Now they have their own repository and release cycle, it's impossible to infer the proper version from the current Pulsar version. We should instead hardcode the corresponding versions for new versions.
--
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] tisonkun commented on a diff in pull request #18477: [improve][doc] Specially handle Python and C++ API documents
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #18477:
URL: https://github.com/apache/pulsar/pull/18477#discussion_r1023458607
##########
site2/docs/client-libraries.md:
##########
@@ -6,14 +6,14 @@ sidebar_label: "Overview"
Pulsar supports the following language-specific client libraries:
-| 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/) | [Standalone](https://github.com/apache/pulsar/pulsar-client-cpp) |
-| Python | [User doc](client-libraries-python.md) <br/> [API doc](/api/python/) | [Bundled](/release-notes/) | [Standalone](https://github.com/apache/pulsar-client-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) |
+| 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/3.0.0) | [Bundled](/release-notes/) | [Standalone](https://github.com/apache/pulsar/pulsar-client-cpp) |
Review Comment:
See the description at https://github.com/apache/pulsar-site/pull/291.
--
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