-
-
Notifications
You must be signed in to change notification settings - Fork 577
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: add protocol concepts doc #1013
Conversation
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
hey @nelsonmic, we're close to the end of GSoD 😄... how is this doc going? When do you think we may see the first draft? ✨✨🙌🏽 |
GSOD is not going to stop me from contributing 😄😊. I'll have this in by Monday. |
Hello @derberg, I'm having a problem with the diagram for this concept doc, please can you help. First, confirm that the doc is technically correct, if it is then in my diagram I want to label the arrow pointing from Here's what i have currently: flowchart LR
a[Producer]-- Message 1 --->c[(Broker)]
c-- Message 1 ---> b[Consumer]
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1013--asyncapi-website.netlify.app/ |
Hello @alequetzalli, good day! I just fixed the issue, please can you have a look at it. |
I think this looks good, but we should def see if @derberg agrees it's ready to merge :) |
hey @nelsonmic, please add to your PR:
|
Hey hey 😌, thank you for the feedback. I'll get right to it. |
Heyo @nelsonmic, looks like you got some conflicts to solve. 😄✌🏽 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yo, left some suggestions
pages/docs/concepts/protocol.md
Outdated
|
||
|
||
## What is a protocol? | ||
A protocol is a mechanism that handles the exchange of messages. It provides a way of getting messages from one point in an event-driven architecture to another. A protocol could either be wired or API. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- protocols are not only in context of the event driven architectures
- what do you mean protocol could be an API?
- I'm not sure
mechanism
is the correct word. A protocol is nothing else than a set of rules that are used to specify how information should be exchanged between applications and/or servers
Co-authored-by: Alejandra Quetzalli <alejandra.quetzalli@postman.com>
Co-authored-by: Alejandra Quetzalli <alejandra.quetzalli@postman.com>
Co-authored-by: Alejandra Quetzalli <alejandra.quetzalli@postman.com>
Hey @nelsonmic! 😄 How's this PR going? do you understand all the feedback @derberg left you? Let's take care of this doc before we create a NEW doc for bindings. |
Hey @derberg please can you review the diagram and definition again, thank you! |
Hi @alequetzalli, I just pushed a commit to address @derberg suggestions, I'm waiting on his feedback |
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Hey @alequetzalli, I have fixed everything that @derberg suggested. This PR is ready for an editorial review from you, thanks. |
I confirm that technically all accurate 👍🏼 |
Side comment. I think Open ai just released one of the best tools that can be used as technical input for docs. example answer to question "what is protocol"
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yay! 😁 congratulations @nelsonmic, great work!
@derberg can you please merge this AND the application PR together now? #992
@derberg you forgot to approve this PR 😜 merging will be blocked until you do it since you requested changes before |
Thank you, thank you, thank you 😁. Bindings concept next |
@alequetzalli oh, I thought it is still pending editorial review, this is why I did not accept as I was sure there will be some additional commits that will dismiss my review. |
@derberg Yo you forgot to merge both PRs 😛 |
/rtm |
Description
protocol
concept specRelated issue(s)
Fixes #980