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

docs: tutorial for bindings with Kafka #2318

Merged

Conversation

CynthiaPeter
Copy link
Contributor

Description

This is an initial draft for a binding with Kafka tutorial.

Copy link

netlify bot commented Nov 14, 2023

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 024e64a
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/65f4e2dc1923ac0008f1dbe0
😎 Deploy Preview https://deploy-preview-2318--asyncapi-website.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@CynthiaPeter CynthiaPeter changed the title docs: Tutorial for bindings with Kafka docs: tutorial for bindings with Kafka Nov 14, 2023
pages/docs/tutorials/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/bindings-with-kafka.md Outdated Show resolved Hide resolved
@CynthiaPeter
Copy link
Contributor Author

CynthiaPeter commented Nov 15, 2023

Some questions I have on this task:

  • Is there an installation guide needed for this topic?
  • What can I build to ensure the reader understands and follows through?
  • How best do I structure this?
  • Where is the best place to let the reader know that they need an AsyncAPI file and maybe (Do they need to set up Kafka?)
  • "Topics are split into partitions; each partition can contain a copy of the messages sent through Kafka. This can be important if you have bindings related to partitions". Jose shared this, and because he mentioned it, I'll add it as a footnote here and think through it. (I thought I'd add it to the Channel binding object sub-topic since that is where topics and partitions are defined as fields).

Answered

  • Do I need to build an app to demonstrate this topic? - An AsyncAPI file? - Yes. I will be using Joy's AsyncAPI document.

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

as far as I remember this was suppose to be a tutorial, one of a series of Kafka tutorials

this one is a tutorial that will be visible after tutorial: where you grab existing AsyncAPI Kafka document from previous tutorials and put schemas in Apicurio schema registry (@Arya-Gupta works on this one afaik)

so in your tutorial you introduce bindings, and you do not have to introduce Kafka again (it should be already done in previous tutorials 🤔 ). So this tutorial explains how to add specific bindings to AsyncAPI document:

  • server with info about schema registry
  • channel or operation binding (depending on the initial shape of AsyncAPI document)

please also learn from #2042 what bindings are in AsyncAPI as Bindings: Bindings are relevant when integrating Kafka with other programs or services. A binding is a specific agreement or configuration that governs how an application connects to and interacts with Kafka sounds like bindings are some Kafka feature

pages/docs/tutorials/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/kafka/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/kafka/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/kafka/bindings-with-kafka.md Outdated Show resolved Hide resolved
pages/docs/tutorials/kafka/bindings-with-kafka.md Outdated Show resolved Hide resolved
derberg
derberg previously approved these changes Mar 14, 2024
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

Thanks so much @CynthiaPeter
LGTM from my side big time!!!

@alequetzalli on to you, I guess you do not want to merge yet as it is mentioning in intro tutorial that is not yet published

Copy link
Contributor

@dalelane dalelane 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 doing this - I think this will be useful

@quetzalliwrites quetzalliwrites requested a review from M3lkior March 15, 2024 22:48
Copy link
Member

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

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

AMAZING WORK, @CynthiaPeter. Thank you ✨ 😻

@quetzalliwrites quetzalliwrites dismissed stale reviews from derberg and themself via 3af3bab March 15, 2024 23:22
Copy link
Member

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

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

:✅

@quetzalliwrites
Copy link
Member

@alequetzalli on to you, I guess you do not want to merge yet as it is mentioning in intro tutorial that is not yet published

Correct @derberg, we first gotta merge @Arya-Gupta's tutorial.

@quetzalliwrites
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 173a0db into asyncapi:master Mar 16, 2024
22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants