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: add message concepts doc #944

Merged
merged 37 commits into from
Nov 9, 2022
Merged

Conversation

thulieblack
Copy link
Member

@thulieblack thulieblack commented Sep 12, 2022

Description

This PR adds the new message concept spec

Related issue(s)

@netlify
Copy link

netlify bot commented Sep 12, 2022

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f404566
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/636c22d9a02316000814955f
😎 Deploy Preview https://deploy-preview-944--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 settings.

@thulieblack
Copy link
Member Author

Hey, @derberg here is the proper PR, thank you 😅

I need help in defining the purpose of the message concept as well as the diagram.

cc. @smoya

@derberg
Copy link
Member

derberg commented Sep 12, 2022

@thulieblack

  • I'm not sure it is possible to represent message concept with a diagram. Can't think of any example
  • I do think it would be a good place to address a question about what is the difference between event and message 😄 maybe even title could be Message vs Event. I'm not sure I want to be part of this academic discussion 😆

I recommend looking at:

Also, I could not help myself, and dragged community into discussion, let's see if they catch a bait 😃

Also, a question I always wanted to ask @fmvilas
"do you recall why we talk about making it easier to work with event-driven architectures, but in spec we have Messages and not Events" 🍿

@fmvilas
Copy link
Member

fmvilas commented Sep 12, 2022

Also, a question I always wanted to ask @fmvilas
"do you recall why we talk about making it easier to work with event-driven architectures, but in spec we have Messages and not Events" 🍿

@derberg Does this reply to your question? https://www.asyncapi.com/docs/tutorials/getting-started/event-driven-architectures#why-event-driven-and-not-message-driven

@derberg
Copy link
Member

derberg commented Sep 12, 2022

@fmvilas not really. I'm more interested if there was some specific reason why we picked to use two terms. Maybe some old issue about it? or maybe you remember 😄

@fmvilas
Copy link
Member

fmvilas commented Sep 12, 2022

Haha! I do know why. Strictly speaking, it's all "messages". A message can be an event, a command, and maybe something else (although I never found a 3rd kind). The spec is a formal document so "message" seems appropriate here. Now that said, event-driven architectures have become more popular in recent years (with the rise of RabbitMQ, Kafka, etc.). And yeah, I mean "event-driven" architectures. Using events only. However, the more popular it got, the more people started doing not-just-events-driven architectures. See, for instance, the case of CQRS (Command-Query Responsibility Segregation). Again, strictly speaking, these are message-driven architectures but the reality is that this name never got popular and most of us are just using event-driven architectures to refer to both, message-driven architectures and event-driven architectures 🤷‍♂️ I guess it sounds cooler with "event" and that won 😄

So for strict stuff like the spec, it's "message" and for communication or marketing, it's "event" because that's what people tend to use the most.

@thulieblack
Copy link
Member Author

Okay so now my question @fmvilas is, should we still go ahead and define the message spec concept or ....?

@derberg
Copy link
Member

derberg commented Sep 13, 2022

@thulieblack we need message as this is what we have in spec. But we also need to address these "event vs message" definitions, to make it clear where to draw the line. So we explain the message, and also add event 😄

btw, I got you lots of ideas 😄 -> https://twitter.com/AsyncAPISpec/status/1569426365903953921 and https://www.linkedin.com/feed/update/urn:li:activity:6975192181678436352?commentUrn=urn%3Ali%3Acomment%3A%28activity%3A6975192181678436352%2C6975358655713980416%29 (I did not expect such a great response from the community 🚀 )

Copy link
Member Author

@thulieblack thulieblack left a comment

Choose a reason for hiding this comment

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

hey @derberg here is the first draft, how is it?

as for the diagram created any suggestions to improve it @fmvilas

@fmvilas
Copy link
Member

fmvilas commented Sep 16, 2022

Looks good to me, @thulieblack. I think we should keep it as simple as possible on this page. Maybe you want to mark this PR as ready for review?

@thulieblack thulieblack marked this pull request as ready for review September 16, 2022 07:56
@github-actions
Copy link

github-actions bot commented Sep 16, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 52
🟠 Accessibility 88
🟠 Best practices 83
🟢 SEO 100
🔴 PWA 30

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

@thulieblack
Copy link
Member Author

Looks good to me, @thulieblack. I think we should keep it as simple as possible on this page. Maybe you want to mark this PR as ready for review?

Done 👌

@quetzalliwrites 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 Sep 20, 2022
pages/docs/concepts/message.md Outdated Show resolved Hide resolved
pages/docs/concepts/message.md Outdated Show resolved Hide resolved
@quetzalliwrites
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit b760cc5 into asyncapi:master Nov 9, 2022
@akshatnema
Copy link
Member

@alequetzalli please always make sure you align the Prev and UpNext buttons properly for adjacent pages also, before merging the PR. I see that with this PR, we again have an issue in Channel page and Tutorials - Overview page. Since we are adding new pages to the documentation, it can't be possible to make separate issue for each page and someone else should come to resolve the error. These buttons should be thoroughly checked until some automation is established for this.

@quetzalliwrites
Copy link
Member

I revised this and all of the buttons work, there is no problem in this PR.

@akshatnema
Copy link
Member

@alequetzalli Look into the screenshots below, they are of Channel and Tutorials - Overview page. The UpNext button of Channel page and Prev Button of Tutorials - Overview.

Prev Button of Tutorials - Overview page:

Screenshot_2022-11-10-20-41-34-46.jpg

UpNext Button of Channel page:

Screenshot_2022-11-10-20-41-12-50.jpg

These buttons has to be updated in this PR, while adding new page in between.

@quetzalliwrites
Copy link
Member

quetzalliwrites commented Nov 10, 2022

@akshatnema yes, every time a new page is added these buttons will need to be updated and that is correct. Yes, we need a new PR to fix the previous page buttons and that is fine.

Her buttons on this page are correct and there is nothing to fix.

image

@akshatnema
Copy link
Member

akshatnema commented Nov 10, 2022

@alequetzalli Yeah, I agree that she added buttons in the page in correct way, but it has to be ensured that every time, a new page is added in docs, it shouldn't break the sequence of the pages linked. For every new page created and added, the buttons should be added on that page and should be updated for the immediate next and previous page.

I can't say that this is the job of who created Channel page because it was added earlier, so if anyone adds any new page in the docs, he has to make changes in the buttons of 3 pages exactly: present new page, immediate next page and previous page.

@thulieblack
Copy link
Member Author

thulieblack commented Nov 10, 2022 via email

@akshatnema
Copy link
Member

every page pushed/added to the website someone needs to update the previous
page buttons so they align properly.

Exactly 👍

@thulieblack thulieblack deleted the message_doc branch November 10, 2022 17:12
@thulieblack
Copy link
Member Author

I have created a PR #1100 to solve this issue @alequetzalli and @akshatnema

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs gsod This label should be used for issues or discussions related to ideas for Google Season of Docs ready-to-merge
Projects
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: new message concept doc
6 participants