-
-
Notifications
You must be signed in to change notification settings - Fork 696
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
Comments
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 ❤️ |
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 |
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 ❤️ |
@derberg Hi sorry I was inactive for some days because of a hackathon I was unable to continue. |
@Jitulteron7 no worries mate. I don't think anyone is working on this one |
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 |
@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 |
Hey @derberg, yes sure |
@derberg can I take this? |
@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 😆 |
Can I use mermaid js? |
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. |
@derberg, how far with what was the conclusion to this? |
conclusion is that we need nice diagram but nobody created it yet |
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. |
@derberg @boyney123 PTAL |
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 |
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 ❤️ |
@Mayaleeeee can you please share a feedback |
Sure! |
Summarising things down |
Looks good to me |
Thank you @TenzDelek
All other thing looks good. |
|
This looks good to me I think we can start implementing it |
@TenzDelek do you want to work on this issue? |
sure, will raise a pr soon .. @sambhavgupta0705 |
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!)
The text was updated successfully, but these errors were encountered: