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

Add producer access mode examples for Java and C++ client. #537

Merged
merged 5 commits into from
Apr 25, 2023

Conversation

shibd
Copy link
Member

@shibd shibd commented Apr 24, 2023

@shibd shibd self-assigned this Apr 24, 2023
@github-actions github-actions bot added the doc Improvements or additions to documentation label Apr 24, 2023
Copy link
Member

@Anonymitaet Anonymitaet left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution!

  1. Soft reminder: do not forget the 2nd task commented in [feat] Support ExclusiveWithFencing producer access mode. pulsar-client-cpp#201 (comment)

  2. Can you provide the code PR link ([feat] Support ExclusiveWithFencing producer access mode. pulsar-client-cpp#201) in the PR description? So that reviewers can have more context on the doc changes.

docs/client-libraries-producers.md Outdated Show resolved Hide resolved
docs/client-libraries-producers.md Outdated Show resolved Hide resolved
docs/client-libraries-producers.md Outdated Show resolved Hide resolved
@shibd
Copy link
Member Author

shibd commented Apr 25, 2023

Soft reminder: do not forget the 2nd task commented in.

Hi, @Anonymitaet The structure of the current document(next) is very different from the previous document(2.11.x, 2.10.x, etc).

I'm not sure where I should add it. And for the CPP client, We don't seem to manage the version of its documentation.

@Anonymitaet
Copy link
Member

Anonymitaet commented Apr 25, 2023

@shibd many thanks for your technical guidance!

Summarized what we discussed just now:

TO-DO tasks:

  1. Add a note indicating the versions for Java and C++ to NEXT.

  2. Record an issue to see if any contributors would like to apply the same doc changes to legacy doc versions.

    Since this feature is available from 2.8.x, docs should be added from then as below.

    The location might not be perfect but it's the most relevant place.

  • Java

image

  • C++

image

But in this PR, we only add docs to NEXT due to limited time and resources.

Instead, we plan to open an issue to see if any contributors would like to apply the same changes to versioned docs.

==========

Record another note for further learning: one value of access mode is available from 2.10.x. That value is shown on the doc set ≥ 2.11.x, so we do not need to update the doc since it's accurate.

docs/client-libraries-producers.md Outdated Show resolved Hide resolved
docs/client-libraries-producers.md Outdated Show resolved Hide resolved
Co-authored-by: Anonymitaet <50226895+Anonymitaet@users.noreply.github.com>
@shibd shibd requested a review from Anonymitaet April 25, 2023 10:44
@Anonymitaet Anonymitaet merged commit c0a708a into apache:main Apr 25, 2023
@Anonymitaet Anonymitaet added this to the 3.0.0 milestone Apr 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants