Skip to content

Conversation

@Anonymitaet
Copy link
Member

@Anonymitaet Anonymitaet commented Jul 6, 2021

Pulsar 2.8 has been released and one of the highlights is transaction API, which supports atomic writes and acknowledgments across multiple topics. It completes our vision of making Pulsar a complete unified messaging and streaming platform.

While the previous transaction docs are incomplete and need to be improved, so I've re-architectured it and added missing contents.

This PR fixes #10971 and it is based on the google doc I collaborated with @congbobo184 and @D-2-Ed, so it should be pretty good already.

@Anonymitaet
Copy link
Member Author

@congbobo184 @jennifer88huang @Huanli-Meng could you please help review? Many thanks

@Anonymitaet Anonymitaet added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Jul 6, 2021
@Anonymitaet Anonymitaet added this to the 2.9.0 milestone Jul 6, 2021
@Anonymitaet Anonymitaet self-assigned this Jul 6, 2021
Copy link
Contributor

@congbobo184 congbobo184 left a comment

Choose a reason for hiding this comment

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

LGTM.

Copy link
Member

@lhotari lhotari left a comment

Choose a reason for hiding this comment

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

LGTM.

I wonder if the Pulsar binary protocol specification https://pulsar.apache.org/docs/en/develop-binary-protocol/ / https://github.com/apache/pulsar/blob/master/site2/docs/developing-binary-protocol.md needs updating to make it consistent with transactions? Any ideas how to cover that?

@codelipenghui codelipenghui merged commit 4a3936e into apache:master Jul 8, 2021
@Anonymitaet Anonymitaet deleted the 0706 branch July 8, 2021 01:18
@Anonymitaet
Copy link
Member Author

Hi @lhotari thanks for your feedback.

I've discussed w/ @congbobo184, we are considering making the following changes to doc:

  1. Add transaction section under the interactions chapter
    image

  2. Add descriptions for transaction command in the source code file (rather than in user guide) and add links of the source code file to the user guide.

Reason:

  • The descriptions are simple.
  • Developers make code changes at any time or frequently (for example, add a transaction command), it is not easy to capture all code changes and sync doc with code. But we provide the source code file link, so that users can be navigated to the source code file to get the latest and complete info.
  1. Add a diagram (something like below) of transaction to the user guide.

image

Any thoughts?

@Anonymitaet
Copy link
Member Author

Hi @lhotari any feedback?

bharanic-dev pushed a commit to bharanic-dev/pulsar that referenced this pull request Mar 18, 2022
Pulsar 2.8 has been released and one of the highlights is transaction API, which supports atomic writes and acknowledgments across multiple topics. It completes our vision of making Pulsar a complete unified messaging and streaming platform.

While the previous transaction docs are incomplete and need to be improved, so I've re-architectured it and added missing contents.

This PR fixes apache#10971 and it is based on the [google doc](https://docs.google.com/document/d/1rChR2ZScYxCDKUmkQTg6inbuhyfrz_jJfdQOFtwO8P0/edit#) I collaborated with @congbobo184 and @D-2-Ed, so it should be pretty good already.
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.

[Doc] Transaction

4 participants