Skip to content

Update INTRODUCTION.md with promisified API #211

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

Merged
merged 5 commits into from
Dec 16, 2024
Merged

Conversation

milindl
Copy link
Contributor

@milindl milindl commented Dec 13, 2024

  1. What the title says.
  2. Also update MIGRATION with the particular version of node-rdkafka migration we support.
  3. I think it's mostly complete. I will link to the API docs whenever I've mentioned them once they are online. This can be in a follow up PR.

@milindl milindl requested review from a team as code owners December 13, 2024 12:13
@confluent-cla-assistant
Copy link

🎉 All Contributor License Agreements have been signed. Ready to merge.
Please push an empty commit if you would like to re-run the checks to verify CLA status for all contributors.

MIGRATION.md Outdated
The rest of the functionality should work as usual.

For later releases, the node-rdkafka API diverges from this library. If you encounter any issues migrating, refer to the [INTRODUCTION.md](./INTRODUCTION.md) for a guide to using this library.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
For later releases, the node-rdkafka API diverges from this library. If you encounter any issues migrating, refer to the [INTRODUCTION.md](./INTRODUCTION.md) for a guide to using this library.
For releases > v2.17.0, the node-rdkafka API diverges from this library. If you encounter any issues migrating, refer to the [INTRODUCTION.md](./INTRODUCTION.md) for a guide to using this library.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Did but with > v2.18.0

Copy link
Contributor

Choose a reason for hiding this comment

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

Right, because we did this merge

@milindl milindl merged commit 5c4d8ac into master Dec 16, 2024
1 of 2 checks passed
@milindl milindl deleted the introduction_document branch December 16, 2024 12:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants