-
-
Notifications
You must be signed in to change notification settings - Fork 62
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
docs: adds getting started guide #483
docs: adds getting started guide #483
Conversation
afzal442
commented
Jul 26, 2023
- Part of [Docs] Milestones for Creating Tutorial Documentation Guides for Glee #480
Signed-off-by: Afzal Ansari <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@afzal442 left some comments, I have a question:
what is glee-template.md
and why do we need it?
--- | ||
This tutorial teaches you how to create a simple glee template. You'll use the AsyncAPI Glee template you develop to generate Javascript code. Additionally, you'll create a template code with a reusable component to reuse the custom functionality you create and test your code using an WS server. | ||
|
||
<CodeBlock> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think it is rendering correctly in GitHub do check it once.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Souvikns I think it is github .md that can't render it.
e.g.
https://github.com/asyncapi/website/blob/master/pages/docs/tutorials/getting-started/hello-world.md
that is a separate file which gives clear understanding of glee-template step by step like this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good work @afzal442, just update the image and example and we can merge this.
Kudos, SonarCloud Quality Gate passed! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job @afzal442 👍🏼
/rtm |
🎉 This PR is included in version 0.26.6 🎉 The release is available on: Your semantic-release bot 📦🚀 |