Add visual on the "generator" and maybe others....

boyney123 commented 2 years ago

Reason/Context

When going to AsyncAPI.com/tools I can see some quick instructions on how to get started which is great, but I feel it would help me understand with some visuals.

To give you an example, the generator.

https://www.asyncapi.com/tools/generator

After talking to @jonaslagoni I know what the generator and templates do, but I feel if there was a simple cool looking diagram on this page I would of got it straight away.

Ignore how rubbish this looks, but if we can get somebody do help with the design maybe we could give more a visual impact on what the generator does.

Example (ignore how bad it looks)

If we had this designed or even better svg animated ;), might be helpful (and pretty cool!)

github-actions[bot] commented 2 years ago

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:

derberg commented 2 years ago

I think diagrams and interactiveness are always good to explain things and make it nicer to digest knowledge. I can help to review the diagram, but for sure won't be able to create it in such professional way 😄 we need help

github-actions[bot] commented 2 years ago

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:

Jitulteron7 commented 1 year ago

@derberg Hi sorry I was inactive for some days because of a hackathon I was unable to continue. Is this issue still active ?

derberg commented 1 year ago

@Jitulteron7 no worries mate. I don't think anyone is working on this one

mcturco commented 1 year ago

Adding design labels here as I think it could be useful to have a designer in this issue to help with the visual design of the diagram

derberg commented 1 year ago

@Florence-Njeri since you are working on more complex diagram for generator documentation, you think you are able to provide a much smaller, condensed, easier version of it, with mermaid, as input

Florence-Njeri commented 1 year ago

Hey @derberg, yes sure

octonawish-akcodes commented 1 year ago

@derberg can I take this?

derberg commented 1 year ago

@octonawish-akcodes sure thing. In Generator docs in the website you will find diagrams that @Florence-Njeri create last year. Just for this task I guess better to simplify them and make it visually appealing as more important here is to have it pretty than useful 😆

octonawish-akcodes commented 1 year ago

Can I use mermaid js?

derberg commented 1 year ago

I don't think so, we already use it in the website, and it has very basic design. I don't think it will look good on https://www.asyncapi.com/tools/generator.

try dragging diagram from https://www.asyncapi.com/docs/tools/generator/asyncapi-document and putting there.