Skip to content
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

[improve][doc] Add documents for C++ client 3.0.0 or later #18574

Merged
merged 6 commits into from
Nov 24, 2022

Conversation

BewareMyPower
Copy link
Contributor

Motivation

It's a followup PR of apache/pulsar-site#300, which shows the download URLs of the separated C++ client repo. This PR adds the guidance to tell users where to download the new released C++ client (3.0.0 or later).

Modifications

Reference the download page for the C++ client 3.0.0 or higher and explain the packages simply. Add a section to describe how to install the APK (Alpine Package Keeper) package.

Documentation

  • doc
  • doc-required
  • doc-not-needed
  • doc-complete

Matching PR in forked repository

PR in forked repository: This is a pure doc related PR, no matching PR is needed.

@BewareMyPower BewareMyPower added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Nov 23, 2022
@BewareMyPower
Copy link
Contributor Author

BewareMyPower commented Nov 23, 2022

Previews:

image

image

20221123153906

@BewareMyPower BewareMyPower changed the title [doc] Add documents for C++ client 3.0.0 or later [improve][doc] Add documents for C++ client 3.0.0 or later Nov 23, 2022
site2/docs/client-libraries-cpp.md Outdated Show resolved Hide resolved
site2/docs/client-libraries-cpp.md Outdated Show resolved Hide resolved
### APK

```bash
apk add --allow-untrusted ./apache-pulsar-client-3.0.0-r0.apk
Copy link
Member

Choose a reason for hiding this comment

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

Do we stick to 3.0.0 in the document here? If so, you may update the links above for other hard linked items (RPM, DEB).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think we can use apache-pulsar-client-*.apk instead.

### APK

```bash
apk add --allow-untrusted ./apache-pulsar-client-3.0.0-r0.apk
Copy link
Member

Choose a reason for hiding this comment

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

Also, it seems to me that -r0 referred to a release candidate, is it a formal release?

Copy link
Contributor Author

Choose a reason for hiding this comment

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


The version of the Pulsar C++ client is no longer consistent with Pulsar after 2.10.x. The new client version starts from 3.0.0. You can turn to [the download page](https://pulsar.apache.org/download) to see the latest releases.

Take the [3.0.0 release](https://archive.apache.org/dist/pulsar/pulsar-client-cpp-3.0.0/) for example, there are following subdirectories:
Copy link
Member

Choose a reason for hiding this comment

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

After 3.0, do we no longer support brew install?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

We still support brew install, see Homebrew/homebrew-core#114737

Copy link
Contributor

@momo-jun momo-jun left a comment

Choose a reason for hiding this comment

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

LGTM

@tisonkun
Copy link
Member

Merging...

@tisonkun tisonkun merged commit 13d3e1d into apache:master Nov 24, 2022
@BewareMyPower BewareMyPower deleted the bewaremypower/cpp-link-url branch November 25, 2022 07:16
lifepuzzlefun pushed a commit to lifepuzzlefun/pulsar that referenced this pull request Dec 9, 2022
lifepuzzlefun pushed a commit to lifepuzzlefun/pulsar that referenced this pull request Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants