website
website copied to clipboard
asyncapi
docs: add protocol concepts doc
Description
- This PR adds a new
protocolconcept spec
Related issue(s)
Fixes #980
Deploy Preview for asyncapi-website ready!
Built without sensitive environment variables
| Name | Link |
|---|---|
| Latest commit | e10f5acd1835f26276b633377e1baf42d5c805f2 |
| Latest deploy log | https://app.netlify.com/sites/asyncapi-website/deploys/638d3c4b9b84cc0009f3f30a |
| Deploy Preview | https://deploy-preview-1013--asyncapi-website.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
To edit notification comments on pull requests, go to your Netlify site settings.
![netlify[bot] avatar](https://avatars.githubusercontent.com/in/13473?v=4 "Published by a pub.dev verified publisher"){kind=small}
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? ✨✨🙌🏽
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 producer to broker to consumer as protocol.
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:
| Category | Score |
|---|---|
| 🟠 Performance | 58 |
| 🟠 Accessibility | 88 |
| 🟠 Best practices | 83 |
| 🟢 SEO | 100 |
| 🔴 PWA | 30 |
Lighthouse ran on https://deploy-preview-1013--asyncapi-website.netlify.app/
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
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:
- The actual diagram syntax markdown, even if you think it has mistakes. I know you put it in some comment, but now it's lost and cannot be easily found to review. In addition, Lukasz will be able to easily add a commit suggestion to you if you actually have that diagram as part of your PR, making it easier to fix any issues the diagram has.
- Prev/Next buttons (I'm putting my application doc before yours)
hey @nelsonmic, please add to your PR:
- The actual diagram syntax markdown, even if you think it has mistakes. I know you put it in some comment, but now it's lost and cannot be easily found to review. In addition, Lukasz will be able to easily add a commit suggestion to you if you actually have that diagram as part of your PR, making it easier to fix any issues the diagram has.
- Prev/Next buttons (I'm putting my application doc before yours)
Hey hey 😌, thank you for the feedback. I'll get right to it.
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!
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.
Hi @alequetzalli, I just pushed a commit to address @derberg suggestions, I'm waiting on his feedback
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 👍🏼 @alequetzalli only your review is needed
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"
A protocol is a set of rules and guidelines that define the communication and interactions between different devices or systems. Protocols ensure that the devices or systems can communicate and exchange information in a consistent and efficient manner. Examples of protocols include the HTTP protocol for web communication, the TCP/IP protocol for internet communication, and the protocols used in wireless networks.
🤯 https://chat.openai.com
@derberg you forgot to approve this PR 😜 merging will be blocked until you do it since you requested changes before
Yay! 😁 congratulations @nelsonmic, great work!
@derberg can you please merge this AND the application PR together now? #992
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.