website icon indicating copy to clipboard operation
website copied to clipboard

doc: new Ordering or Shopping AsyncAPI Tutorial

Open boyney123 opened this issue 2 years ago • 10 comments

Reason/Context

Going through the process at the moment gaining deeper knowledge on AsyncAPI, and I can see we have two main tutorials:

I remember when learning Event-Driven Architectures over the past few years a fair few people have examples like "Food Ordering" or "Shopping" tutorials, which can relate quite easily to real world examples.

I would like to propose adding a new tutorial maybe "Ordering System" or something, it could cover:

  • Account Creation
  • Adding items to the shopping cart
  • The purchasing of an item

With some diagrams > Code > AsyncAPI it might be helpful for the community coming at AsyncAPI new?

boyney123 avatar Sep 30 '21 09:09 boyney123

I will ask about this in my next 1:1 and see what @derberg thinks! 😀👍🏽

quetzalliwrites avatar Oct 01 '21 18:10 quetzalliwrites

@alequetzalli no need to wait for 1:1. Let us discuss here so others can see too 😉

@boyney123 you're basically suggesting to have tutorials that are use-case-oriented, right? this makes sense but first we would need to have the AsyncAPI files used here, on the list of official examples in the spec repo?

derberg avatar Oct 04 '21 11:10 derberg

@alequetzalli it is like with the websocket use case I told you about, that I wrote a bunch of blog posts, there is also official example, now we need a set of docs for it, on a real use case I think, the Gemini WebSocket API, or some other API if we want, there are quite few out there

derberg avatar Oct 04 '21 11:10 derberg

you're basically suggesting to have tutorials that are use-case-oriented, right? this makes sense but first we would need to have the AsyncAPI files used here, on the list of official examples in the spec repo?

Yeah, I think (from my point of view), something I can relate to more.

Like traffic light I understand and can relate fine, but I mean something more "day-to-day" I guess, like ecommerce etc.

When I was working in a product, I would probably search or expect something more those kinds of lines, something I could relate too abit more.

Also I'm going to spike out using https://github.com/code-hike/codehike to see if that can help "interactive" tutorials too, which allows people to scroll take their time and understand each part of the spec file one section at a time.

Example here: https://code-hike-scrollycoding-preview.vercel.app/posts/lorem-ipsum-three

boyney123 avatar Oct 05 '21 08:10 boyney123

Like traffic light I understand and can relate fine, but I mean something more "day-to-day" I guess, like ecommerce etc.

definitely. Good example of day-to-day activity (maybe not during pandemia 😆 ) is here -> https://github.com/amadeus4dev/amadeus-async-flight-status

I suggest that it goes in parallel to add it to examples in spec repo, so tutorial or a blog post is one, but also yamls in spec repo are important as people go there quite often

derberg avatar Oct 05 '21 09:10 derberg

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Apr 16 '22 00:04 github-actions[bot]

Hi @alequetzalli I am Ekekenta Odionyenfe Clinton. I am a software engineer and a technical writer with 3 years of experience. I have authored for companies like Logrockets, OpenReplay, Loginradius, Arctype, Fauna, etc.

I love to contribute to AsyncAPI on the Google Season of docs 2022. I can create a tutorial on this issues.

icode247 avatar Apr 19 '22 09:04 icode247

Welcome @icode247! It's too early to assign this gsod issue out yet. ❤️

Please follow the updates and instructions in our Slack channel, temp-gsod-2022. ✨✨

quetzalliwrites avatar Apr 19 '22 22:04 quetzalliwrites

Hi, @alequetzalli Is there any update on this issue?

luphieanza avatar May 05 '22 16:05 luphieanza

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

github-actions[bot] avatar Sep 03 '22 00:09 github-actions[bot]