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

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

Open
boyney123 opened this issue Oct 5, 2021 · 29 comments · May be fixed by #3492
Open

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

boyney123 opened this issue Oct 5, 2021 · 29 comments · May be fixed by #3492
Labels
area/design Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 🎨 design Design thinking/mockups needed enhancement good first issue Good for newcomers

Comments

@boyney123
Copy link
Contributor

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)

image

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

@github-actions
Copy link

github-actions bot commented Feb 3, 2022

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

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 ❤️

@github-actions github-actions bot added the stale label Feb 3, 2022
@derberg
Copy link
Member

derberg commented Feb 3, 2022

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

@derberg derberg removed the stale label Feb 3, 2022
@github-actions
Copy link

github-actions bot commented Jun 4, 2022

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

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 ❤️

@github-actions github-actions bot added the stale label Jun 4, 2022
@derberg derberg added good first issue Good for newcomers area/typescript Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. and removed stale labels Jun 7, 2022
@Jitulteron7
Copy link

Jitulteron7 commented Sep 2, 2022

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

@derberg
Copy link
Member

derberg commented Sep 5, 2022

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

@mcturco mcturco added area/design Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 🎨 design Design thinking/mockups needed labels Sep 6, 2022
@mcturco mcturco moved this to Contributions Needed in Design [old] Sep 6, 2022
@mcturco
Copy link
Member

mcturco commented Sep 6, 2022

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
Copy link
Member

derberg commented Sep 7, 2022

@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
Copy link
Contributor

Hey @derberg, yes sure

@octonawish-akcodes
Copy link
Contributor

@derberg can I take this?

Copy link
Member

derberg commented Apr 3, 2023

@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
Copy link
Contributor

Can I use mermaid js?

Copy link
Member

derberg commented Apr 3, 2023

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.

@rukundob451
Copy link
Contributor

@derberg, how far with what was the conclusion to this?

Copy link
Member

derberg commented May 23, 2023

conclusion is that we need nice diagram but nobody created it yet

@120EE0980
Copy link

I would like to do this,and this is my first time doing something like this,I hope someone helps with my queries in the process.

@bEluga0000
Copy link

Async Yml (2)
you guys want like this

@sambhavgupta0705
Copy link
Member

@derberg @boyney123 PTAL

Copy link
Member

derberg commented Apr 16, 2024

I'm the last one to share opinion about design 😆

it for sure needs to be aligned with system used in website. Maybe @Mayaleeeee can share a feedback

@Mayaleeeee Mayaleeeee moved this to Upcoming in Design May 23, 2024
Copy link

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

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 ❤️

@github-actions github-actions bot added the stale label Aug 15, 2024
@sambhavgupta0705
Copy link
Member

@Mayaleeeee can you please share a feedback

@github-actions github-actions bot removed the stale label Aug 26, 2024
@Mayaleeeee
Copy link
Member

@Mayaleeeee can you please share a feedback

Sure!
Thanks for the pinging.

@sambhavgupta0705
Copy link
Member

Summarising things down
For this issue we need a diagram and just need to implement it in the code

@sambhavgupta0705 sambhavgupta0705 added good first issue Good for newcomers and removed good first issue Good for newcomers area/typescript Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. labels Sep 13, 2024
@TenzDelek
Copy link
Contributor

generator
cc @Mayaleeeee @sambhavgupta0705

@sambhavgupta0705
Copy link
Member

Looks good to me

@Mayaleeeee
Copy link
Member

generator cc @Mayaleeeee @sambhavgupta0705

Thank you @TenzDelek
Nice work on the design. I’ve got a few ideas for tweaks that could make it even better:

  • please increase the icon for 'AsyncAPI.yml'
  • reduce the shape of 'Generator'
  • let's use a curly arrow - like the one shown here

All other thing looks good.

@TenzDelek
Copy link
Contributor

asycn
cc @Mayaleeeee

@sambhavgupta0705
Copy link
Member

This looks good to me

I think we can start implementing it

@sambhavgupta0705
Copy link
Member

@TenzDelek do you want to work on this issue?

@TenzDelek
Copy link
Contributor

sure, will raise a pr soon .. @sambhavgupta0705

@TenzDelek TenzDelek linked a pull request Dec 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/design Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 🎨 design Design thinking/mockups needed enhancement good first issue Good for newcomers
Projects
Status: Upcoming
Status: Contributions Needed
Development

Successfully merging a pull request may close this issue.