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

docs: adds getting started guide #483

Merged
merged 20 commits into from
Sep 19, 2023

Conversation

afzal442
Copy link
Contributor

Signed-off-by: Afzal Ansari <[email protected]>
@afzal442 afzal442 marked this pull request as draft July 26, 2023 14:59
@afzal442 afzal442 marked this pull request as ready for review September 10, 2023 18:36
Copy link
Member

@Souvikns Souvikns left a 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?

docs/getting-started.md Outdated Show resolved Hide resolved
docs/getting-started.md Outdated Show resolved Hide resolved
---
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>
Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/getting-started.md Outdated Show resolved Hide resolved
@afzal442 afzal442 requested a review from Souvikns September 12, 2023 14:10
@afzal442
Copy link
Contributor Author

afzal442 commented Sep 12, 2023

what is glee-template.md and why do we need it?

that is a separate file which gives clear understanding of glee-template step by step like this.

Copy link
Member

@Souvikns Souvikns left a 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.

docs/getting-started.md Outdated Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Sep 14, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@afzal442 afzal442 requested a review from Souvikns September 14, 2023 09:31
Copy link
Member

@Souvikns Souvikns left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job @afzal442 👍🏼

@Souvikns
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 97a4b44 into asyncapi:master Sep 19, 2023
12 checks passed
@afzal442 afzal442 deleted the create-getting-started-guide branch September 19, 2023 06:49
@asyncapi-bot
Copy link
Contributor

🎉 This PR is included in version 0.26.6 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants