website icon indicating copy to clipboard operation
website copied to clipboard

Add an AsyncAPI poster showing all features at a glance

Open smoya opened this issue 2 years ago • 32 comments

Reason/Context

I noticed people from serverlessworkflow.io have a poster image where they show all their features at a glance. It seems like a cheat sheet but it's more like a "here is all you can do". See https://serverlessworkflow.io/img/sw-poster.png.

I believe creating one for AsyncAPI will help potential users to quickly see and show all the things AsyncAPI can do for them, meaning adoption could be easier. Of course it can also be used as a small reference guide (even though it is not a cheat-sheet) to refresh developers knowledge.

As a user, those are few examples of questions the poster might answer to me:

  • What are the things I can define in my AsyncAPI file?
  • Are all the main protocols used at my company supported?
  • What tooling do I have available?
  • Can I generate nice documentation from my AsyncAPI file?
  • Is there any IDE extension such as VSCode one?
  • Can I generate code from my AsyncAPI file?

Description

  • Create a visual poster. Can have several formats. Downloadables usually are pdf, but embeddable could be svg and/or png.
  • Embed the poster into our website. TBD where.

smoya avatar Oct 12 '21 10:10 smoya

I love this idea and I am excited to see what others think this poster should include.

quetzalliwrites avatar Oct 12 '21 22:10 quetzalliwrites

for me these are always like a good cheat sheet, so highlighting all features:

  • bindings aka protocol agnostic
  • different payload schemas support (no need for json schema, you can use avro)
  • JSON $ref feature for reusability
  • Traits
  • example of usage with CloudEvents?
  • why not example of usage with SererlessWorkflow?

and also:

  • community channels where people can enage
  • some cool core tools (modelina, generator, glee, others?)
  • meetings calendar

Anythink I'm missing?

Might be we need 2 posters, one for AsyncAPI Specification, one for AsyncAPI tools, or event one more for AsyncAPI Initiative where we talk separately about the community 🤔

derberg avatar Oct 13 '21 09:10 derberg

Yeah think the idea is great.

Think we might also want to include the basics, or have two files maybe?

Things I would like to see (if never seen AsyncAPI):

  • Operations
  • Channels
  • Event examples
  • Application info
  • etc

Maybe an intro into AsyncAPI cheatsheet too?

boyney123 avatar Oct 13 '21 10:10 boyney123

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 Feb 11 '22 01:02 github-actions[bot]

I think this is still relevant! I can't remove the stale label btw!

smoya avatar Feb 11 '22 11:02 smoya

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 Jun 13 '22 00:06 github-actions[bot]

This didn't have enough traction. Not sure if its still relevant.

smoya avatar Jun 13 '22 09:06 smoya

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 Oct 12 '22 00:10 github-actions[bot]

I still think this can be useful but to be honest, after a year, not sure if this is gonna happen.

Do you still consider it something we wanna do? cc @Mayaleeeee @derberg @alequetzalli @fmvilas

smoya avatar Oct 12 '22 09:10 smoya

I also think it is useful, not only a poster, kind of infographic too. We just need someone talented who could design it. And all of us can help defining what content should go there

derberg avatar Oct 12 '22 10:10 derberg

I really like the idea and would have wanted to take it on, but I'm concentrating on a mentorship program this month, so I won't have time to work on it at the moment @smoya. If it's still open by next month, though, I'll fo for it 🥰🥰😌.

Mayaleeeee avatar Oct 12 '22 16:10 Mayaleeeee