docs: add protocol concepts doc #1013

nelsonmic · 2022-10-11T13:01:33Z

Description

This PR adds a new protocol concept spec

Related issue(s)

Fixes #980

netlify · 2022-10-11T13:01:44Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`e10f5ac`
🔍 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.

quetzalliwrites · 2022-10-26T01:54:26Z

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? ✨✨🙌🏽

nelsonmic · 2022-10-29T20:49:13Z

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.

nelsonmic · 2022-10-30T17:02:22Z

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]

github-actions · 2022-10-30T17:03:11Z

⚡️ 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/

pages/docs/concepts/channel.md

pages/docs/concepts/protocol.md

nelsonmic · 2022-11-07T13:51:35Z

Hello @alequetzalli, good day! I just fixed the issue, please can you have a look at it.

quetzalliwrites · 2022-11-07T15:50:57Z

I think this looks good, but we should def see if @derberg agrees it's ready to merge :)

quetzalliwrites · 2022-11-07T21:07:27Z

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)

nelsonmic · 2022-11-08T12:19:35Z

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.

quetzalliwrites · 2022-11-08T22:52:16Z

Heyo @nelsonmic, looks like you got some conflicts to solve. 😄✌🏽

derberg

yo, left some suggestions

pages/docs/concepts/protocol.md

derberg · 2022-11-09T18:24:18Z

pages/docs/concepts/protocol.md

+
+
+## 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.


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 <[email protected]>

quetzalliwrites · 2022-11-16T00:23:03Z

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.

nelsonmic · 2022-11-16T15:07:53Z

Hey @derberg please can you review the diagram and definition again, thank you!

nelsonmic · 2022-11-16T15:34:17Z

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

pages/docs/concepts/protocol.md

Co-authored-by: Lukasz Gornicki <[email protected]>

nelsonmic · 2022-11-27T01:25:22Z

Hey @alequetzalli, I have fixed everything that @derberg suggested. This PR is ready for an editorial review from you, thanks.

derberg · 2022-12-01T12:03:34Z

I confirm that technically all accurate 👍🏼
@alequetzalli only your review is needed

derberg · 2022-12-02T08:03:41Z

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

quetzalliwrites

Yay! 😁 congratulations @nelsonmic, great work!

@derberg can you please merge this AND the application PR together now? #992

quetzalliwrites · 2022-12-03T00:05:32Z

@derberg you forgot to approve this PR 😜 merging will be blocked until you do it since you requested changes before

nelsonmic · 2022-12-05T00:34:32Z

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

derberg · 2022-12-05T11:44:56Z

@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.

quetzalliwrites · 2022-12-05T17:47:57Z

@derberg Yo you forgot to merge both PRs 😛

derberg · 2022-12-06T07:59:24Z

/rtm

nelsonmic marked this pull request as ready for review October 30, 2022 17:02

nelsonmic requested review from quetzalliwrites and asyncapi-bot-eve as code owners October 30, 2022 17:02

quetzalliwrites requested a review from derberg October 31, 2022 23:23

quetzalliwrites assigned nelsonmic Oct 31, 2022

quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Oct 31, 2022

quetzalliwrites reviewed Oct 31, 2022

View reviewed changes

pages/docs/concepts/channel.md Outdated Show resolved Hide resolved

quetzalliwrites reviewed Oct 31, 2022

View reviewed changes

pages/docs/concepts/protocol.md Outdated Show resolved Hide resolved

quetzalliwrites reviewed Oct 31, 2022

View reviewed changes

pages/docs/concepts/protocol.md Outdated Show resolved Hide resolved

quetzalliwrites reviewed Oct 31, 2022

View reviewed changes

pages/docs/concepts/protocol.md Outdated Show resolved Hide resolved

derberg requested changes Nov 9, 2022

View reviewed changes

nelsonmic and others added 7 commits November 10, 2022 15:47

setup protocol docs

c077aec

complete protocol definition

bf91f34

complete why we need protocols section

cda1904

added protocol concept diagram

082d54f

Update pages/docs/concepts/protocol.md

89c70f8

Co-authored-by: Alejandra Quetzalli <[email protected]>

Update pages/docs/concepts/protocol.md

e07d5ea

Co-authored-by: Alejandra Quetzalli <[email protected]>

Update pages/docs/concepts/protocol.md

d61e821

Co-authored-by: Alejandra Quetzalli <[email protected]>

diagram update

2a4257d

quetzalliwrites added 2 commits November 18, 2022 09:30

Merge branch 'master' into protocol

fa20e32

Merge branch 'master' into protocol

312b510

derberg requested changes Nov 22, 2022

View reviewed changes

pages/docs/concepts/protocol.md Outdated Show resolved Hide resolved

pages/docs/concepts/protocol.md Outdated Show resolved Hide resolved

pages/docs/concepts/protocol.md Outdated Show resolved Hide resolved

quetzalliwrites and others added 6 commits November 22, 2022 16:56

Merge branch 'master' into protocol

0c93340

Update pages/docs/concepts/protocol.md

d70957b

Co-authored-by: Lukasz Gornicki <[email protected]>

Update pages/docs/concepts/protocol.md

d30b35a

Co-authored-by: Lukasz Gornicki <[email protected]>

Merge branch 'master' into protocol

ec9b7e1

Merge branch 'master' into protocol

851e24f

update diagram

60be610

quetzalliwrites and others added 2 commits November 29, 2022 21:24

Merge branch 'master' into protocol

698214a

Merge branch 'master' into protocol

5fdc1d1

Merge branch 'master' into protocol

83febc1

quetzalliwrites approved these changes Dec 3, 2022

View reviewed changes

Merge branch 'master' into protocol

e10f5ac

derberg approved these changes Dec 5, 2022

View reviewed changes

asyncapi-bot added the ready-to-merge label Dec 6, 2022

asyncapi-bot merged commit 02a1a6d into asyncapi:master Dec 6, 2022

nelsonmic deleted the protocol branch December 8, 2022 15:20

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add protocol concepts doc #1013

docs: add protocol concepts doc #1013

nelsonmic commented Oct 11, 2022

netlify bot commented Oct 11, 2022 •

edited

Loading

quetzalliwrites commented Oct 26, 2022

nelsonmic commented Oct 29, 2022

nelsonmic commented Oct 30, 2022

github-actions bot commented Oct 30, 2022 •

edited

Loading

nelsonmic commented Nov 7, 2022

quetzalliwrites commented Nov 7, 2022

quetzalliwrites commented Nov 7, 2022 •

edited

Loading

nelsonmic commented Nov 8, 2022

quetzalliwrites commented Nov 8, 2022

derberg left a comment

derberg Nov 9, 2022

quetzalliwrites commented Nov 16, 2022

nelsonmic commented Nov 16, 2022

nelsonmic commented Nov 16, 2022

nelsonmic commented Nov 27, 2022

derberg commented Dec 1, 2022

derberg commented Dec 2, 2022

quetzalliwrites left a comment

quetzalliwrites commented Dec 3, 2022

nelsonmic commented Dec 5, 2022

derberg commented Dec 5, 2022

quetzalliwrites commented Dec 5, 2022

derberg commented Dec 6, 2022



		## 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.

docs: add protocol concepts doc #1013

docs: add protocol concepts doc #1013

Conversation

nelsonmic commented Oct 11, 2022

netlify bot commented Oct 11, 2022 • edited Loading

✅ Deploy Preview for asyncapi-website ready!

quetzalliwrites commented Oct 26, 2022

nelsonmic commented Oct 29, 2022

nelsonmic commented Oct 30, 2022

github-actions bot commented Oct 30, 2022 • edited Loading

nelsonmic commented Nov 7, 2022

quetzalliwrites commented Nov 7, 2022

quetzalliwrites commented Nov 7, 2022 • edited Loading

nelsonmic commented Nov 8, 2022

quetzalliwrites commented Nov 8, 2022

derberg left a comment

Choose a reason for hiding this comment

derberg Nov 9, 2022

Choose a reason for hiding this comment

quetzalliwrites commented Nov 16, 2022

nelsonmic commented Nov 16, 2022

nelsonmic commented Nov 16, 2022

nelsonmic commented Nov 27, 2022

derberg commented Dec 1, 2022

derberg commented Dec 2, 2022

quetzalliwrites left a comment

Choose a reason for hiding this comment

quetzalliwrites commented Dec 3, 2022

nelsonmic commented Dec 5, 2022

derberg commented Dec 5, 2022

quetzalliwrites commented Dec 5, 2022

derberg commented Dec 6, 2022

netlify bot commented Oct 11, 2022 •

edited

Loading

github-actions bot commented Oct 30, 2022 •

edited

Loading

quetzalliwrites commented Nov 7, 2022 •

edited

Loading