docs: add new consumer concept doc #991

Annysah · 2022-09-29T19:16:04Z

Description

New concept doc: Consumer concept

Related issue(s)
Fixes #975

netlify · 2022-09-29T19:16:09Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`637ba03`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/6357299497530800083676ee
😎 Deploy Preview	https://deploy-preview-991--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.

Annysah · 2022-09-29T19:17:24Z

Hello @alequetzalli & @derberg, I will love your feedbacks.
Thank you!

github-actions · 2022-09-29T19:18:41Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🔴 Performance	44
🟠 Accessibility	88
🟠 Best practices	83
🟢 SEO	90
🔴 PWA	30

Lighthouse ran on https://deploy-preview-991--asyncapi-website.netlify.app/

alequetzalli · 2022-09-29T19:49:33Z

AMAZING WORK on your first Concept Doc and nice new diagram! Thank you for your contribution ✨✨✨

Let's get a technical review from folks like @derberg, @fmvilas and/or @smoya first, and once technical feedback is done, I will conduct an editorial review.

alequetzalli · 2022-09-29T19:52:04Z

pages/docs/concepts/consumer.md

+## What is a Consumer?
+In an Event Driven Architecture (EDA), a consumer is a component of an application or messaging system that listens for a particular event from a broker and takes the necessary action in response.
+
+## Why do we need Consumers?


Suggested change

## Why do we need Consumers?

## What is the purpose of Consumers?

This is the outline all Concept Docs will have: What is the purpose of _____?

Okay, I will correct that asap!

don't hate but i changed my mind :D haha!

Let's stick with your original one, I went ahead and fixed it :D

derberg

Nice! Left some comments

thought: since we have producer document already in master
maybe, maybe it is good it interlink them? So at the end of your document you can add a note like: "yo, subscribers can actually also be producers. Go to this blabla to learn what producer is". and similar note could be added to the producer doc. Thoughts?

derberg · 2022-10-06T10:06:13Z

pages/docs/concepts/consumer.md

+---
+
+## What is a Consumer?
+In an Event Driven Architecture (EDA), a consumer is a component of an application or messaging system that listens for a particular event from a broker and takes the necessary action in response.


Suggested change

In an Event Driven Architecture (EDA), a consumer is a component of an application or messaging system that listens for a particular event from a broker and takes the necessary action in response.

In an Event Driven Architecture (EDA), a consumer is an application that listens for a particular event from a broker and reacts to it.

application

I think it is good to be consistent with producer document that was just released

takes the necessary action in response

I would avoid response as it is known term in request/response pattern, and might be suggest consumer sends a response

derberg · 2022-10-06T10:17:30Z

pages/docs/concepts/consumer.md

+In an Event Driven Architecture (EDA), a consumer is a component of an application or messaging system that listens for a particular event from a broker and takes the necessary action in response.
+
+## What is the purpose of Consumers?
+Unlike traditional RestAPIs, EDA creates a setting where there is never a wait for requests or responses to an event. In this pattern, a consumer is unaware of the producer or other consumers; all they know is that when a broker sends them an event they are subscribed to, they receive it.


Suggested change

Unlike traditional RestAPIs, EDA creates a setting where there is never a wait for requests or responses to an event. In this pattern, a consumer is unaware of the producer or other consumers; all they know is that when a broker sends them an event they are subscribed to, they receive it.

Unlike traditional REST APIs, in EDA, consumers of the event are not expected to respond immediately on the same connection. In this architecture, a consumer is unaware of the producer or other consumers; all they know is that when a broker sends them an event, it is because they subscribed to it.

how about this? just to clarify about communication that it is not on sync, because sometimes people do request/response in EDA, but it is still async. Like in DM on Slack, you send question, you do not know who will answer, but you definitely expect that in a thread at some point of time someone will send a response. Makes sense

you can freely adjust the paragraph, my suggestions are just to "visualize" what I mean

derberg · 2022-10-06T10:19:31Z

pages/docs/concepts/consumer.md

+    f
+    end
+```
+The diagram above depicts an example of the flow of events from a producer to a broker and then to the consumers. In this instance, the producer publishes two events, A & B and sends to the broker. Then each consumer receives events from what it is subscribed to.


Suggested change

The diagram above depicts an example of the flow of events from a producer to a broker and then to the consumers. In this instance, the producer publishes two events, A & B and sends to the broker. Then each consumer receives events from what it is subscribed to.

The diagram above depicts an example of the flow of events from a producer to a broker and then to the consumers. In this instance, the producer publishes two events, A & B, and sends them to the broker. Then each consumer receives events that they are subscribed to.

Annysah · 2022-10-07T00:20:23Z

Nice! Left some comments

thought: since we have producer document already in master maybe, maybe it is good it interlink them? So at the end of your document you can add a note like: "yo, subscribers can actually also be producers. Go to this blabla to learn what producer is". and similar note could be added to the producer doc. Thoughts?

Great idea!

Annysah · 2022-10-07T00:22:10Z

I will make all the requested changes. Thanks @derberg

Annysah · 2022-10-07T00:49:11Z

Dear @alequetzalli & @derberg, I just updated the content to be in sync with the requested changes

derberg

Perfect! I just noticed one formatting issue

derberg · 2022-10-12T07:53:10Z

pages/docs/concepts/consumer.md

+The above diagram depicts a sample flow of events from producer to broker and consumer. In this instance, the producer publishes two events, A & B, and sends them to the broker. Then each consumer subscribes to receive those events.
+
+<Remember>
+`Subscribers` can also be [`producers`](https://www.asyncapi.com/docs/concepts/producer).


I don't think markdown render well in the component

isn't it better to just do markdown note/quote >

Ahhh haha noooo. ✌🏽😂

In this scenario, I believe Anisat's original idea to use our React Remember component is a good idea because it's a helpful visual reminder that stands out.

The solution (to me) is to instead use appropriate HTML tags within our React Remember component, and then teach Anisat that we can't use MD syntax in these components. 😄🙌🏽

I fixed it and think this looks good to merge now too 🎉🎉🎉

derberg · 2022-10-18T13:02:05Z

@Annysah heyo, just pinging you as looks like just one tiny change is needed and we can merge

Annysah · 2022-10-21T18:09:56Z

@Annysah heyo, just pinging you as looks like just one tiny change is needed and we can merge

Thanks @derberg, I will do the update now.

alequetzalli

🚢 🛳 🚢 🛳 🚢 🛳 🚢 🛳 🚢 🛳 🚢 🛳 🚢 🛳

derberg · 2022-10-25T16:09:19Z

@all-contributors please add @Annysah for docs

allcontributors · 2022-10-25T16:09:28Z

@derberg

I've put up a pull request to add @Annysah! 🎉

docs: add consumer concept page

f171035

Annysah requested review from alequetzalli and asyncapi-bot-eve as code owners September 29, 2022 19:16

Annysah and others added 3 commits September 29, 2022 19:31

update weight meta-data

3c8db99

update consumer doc meta-data

1709086

Merge branch 'master' into annysah/consumer

662770b

alequetzalli requested review from derberg, fmvilas and smoya September 29, 2022 19:47

alequetzalli assigned Annysah Sep 29, 2022

alequetzalli 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 Sep 29, 2022

alequetzalli added this to Community PR under Review 🧐 in AsyncAPI Docs Board Sep 29, 2022

alequetzalli reviewed Sep 29, 2022

View reviewed changes

update the header title

f253097

derberg reviewed Oct 6, 2022

View reviewed changes

update the consumer concept page

45b9939

alequetzalli added 3 commits October 6, 2022 18:30

Merge branch 'master' into annysah/consumer

608a3c9

some editorial fixes

9b57577

fixed broken end tag

c20ae42

derberg reviewed Oct 12, 2022

View reviewed changes

Merge branch 'asyncapi:master' into annysah/consumer

030f057

Annysah and others added 4 commits October 21, 2022 18:15

change remember component to note markdown

8a02d1a

Merge branch 'master' into annysah/consumer

a7b01a2

styling improvements

f53b7d6

Punctuation fix

637ba03

alequetzalli approved these changes Oct 25, 2022

View reviewed changes

alequetzalli merged commit 3854508 into asyncapi:master Oct 25, 2022

alequetzalli moved this from Community PR under Review 🧐 to Done 🚀 in AsyncAPI Docs Board Oct 25, 2022

allcontributors bot mentioned this pull request Oct 25, 2022

chore: add Annysah as a contributor for doc #1043

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add new consumer concept doc #991

docs: add new consumer concept doc #991

Annysah commented Sep 29, 2022

netlify bot commented Sep 29, 2022 •

edited

Annysah commented Sep 29, 2022

github-actions bot commented Sep 29, 2022 •

edited

alequetzalli commented Sep 29, 2022 •

edited

alequetzalli Sep 29, 2022

Annysah Sep 30, 2022

alequetzalli Oct 8, 2022

Annysah Oct 8, 2022

derberg left a comment

derberg Oct 6, 2022

derberg Oct 6, 2022

derberg Oct 6, 2022

Annysah commented Oct 7, 2022

Annysah commented Oct 7, 2022

Annysah commented Oct 7, 2022

derberg left a comment

derberg Oct 12, 2022

alequetzalli Oct 25, 2022

derberg commented Oct 18, 2022

Annysah commented Oct 21, 2022

alequetzalli left a comment

derberg commented Oct 25, 2022

allcontributors bot commented Oct 25, 2022

	## Why do we need Consumers?
	## What is the purpose of Consumers?

	In an Event Driven Architecture (EDA), a consumer is a component of an application or messaging system that listens for a particular event from a broker and takes the necessary action in response.
	In an Event Driven Architecture (EDA), a consumer is an application that listens for a particular event from a broker and reacts to it.

	Unlike traditional RestAPIs, EDA creates a setting where there is never a wait for requests or responses to an event. In this pattern, a consumer is unaware of the producer or other consumers; all they know is that when a broker sends them an event they are subscribed to, they receive it.
	Unlike traditional REST APIs, in EDA, consumers of the event are not expected to respond immediately on the same connection. In this architecture, a consumer is unaware of the producer or other consumers; all they know is that when a broker sends them an event, it is because they subscribed to it.

	The diagram above depicts an example of the flow of events from a producer to a broker and then to the consumers. In this instance, the producer publishes two events, A & B and sends to the broker. Then each consumer receives events from what it is subscribed to.
	The diagram above depicts an example of the flow of events from a producer to a broker and then to the consumers. In this instance, the producer publishes two events, A & B, and sends them to the broker. Then each consumer receives events that they are subscribed to.

docs: add new consumer concept doc #991

docs: add new consumer concept doc #991

Conversation

Annysah commented Sep 29, 2022

netlify bot commented Sep 29, 2022 • edited

✅ Deploy Preview for asyncapi-website ready!

Annysah commented Sep 29, 2022

github-actions bot commented Sep 29, 2022 • edited

alequetzalli commented Sep 29, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

derberg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Annysah commented Oct 7, 2022

Annysah commented Oct 7, 2022

Annysah commented Oct 7, 2022

derberg left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

derberg commented Oct 18, 2022

Annysah commented Oct 21, 2022

alequetzalli left a comment

Choose a reason for hiding this comment

derberg commented Oct 25, 2022

allcontributors bot commented Oct 25, 2022

netlify bot commented Sep 29, 2022 •

edited

github-actions bot commented Sep 29, 2022 •

edited

alequetzalli commented Sep 29, 2022 •

edited