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 an installation guide #479

Merged
merged 13 commits into from
Sep 25, 2023

Conversation

afzal442
Copy link
Contributor

@afzal442 afzal442 commented Jul 24, 2023

Description
This PR adds intro and installation guide part to the new documentation guide.

Related issue(s)

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.

Copy link
Member

@KhudaDad414 KhudaDad414 left a comment

Choose a reason for hiding this comment

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

@alequetzalli you might want to take a look?

docs/installation.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
docs/intro.md Outdated Show resolved Hide resolved
docs/intro.md Outdated Show resolved Hide resolved
docs/intro.md Outdated Show resolved Hide resolved
afzal442 added 2 commits July 26, 2023 14:10
Signed-off-by: Afzal Ansari <[email protected]>
Signed-off-by: Afzal Ansari <[email protected]>
@afzal442 afzal442 marked this pull request as draft July 26, 2023 14:29
Signed-off-by: Afzal Ansari <[email protected]>
docs/pages/installation.md Outdated Show resolved Hide resolved
docs/pages/intro.md Outdated Show resolved Hide resolved
docs/pages/intro.md Outdated Show resolved Hide resolved
@afzal442 afzal442 force-pushed the create-installation-guide branch 2 times, most recently from 91b6c03 to a78d962 Compare August 1, 2023 14:30
@afzal442 afzal442 force-pushed the create-installation-guide branch from a78d962 to c42a11f Compare August 1, 2023 14:38
@afzal442 afzal442 changed the title docs: adds intro and installation guide part docs: adds installation guide and usage part Sep 16, 2023
@afzal442 afzal442 marked this pull request as ready for review September 18, 2023 18:10
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 good work, left some comments.

docs/pages/usage.md Outdated Show resolved Hide resolved
Also, you can already open the project in your favorite editor and start tweaking it
```

While making twists to your application, you can follow along with our getting started guide on the relevant page.
Copy link
Member

Choose a reason for hiding this comment

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

I think adding the link will be useful.

Copy link
Contributor Author

@afzal442 afzal442 Sep 19, 2023

Choose a reason for hiding this comment

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

Yes! I will do that once page rendered or reviewed with a link on the website itself

@afzal442 afzal442 changed the title docs: adds installation guide and usage part docs: adds an installation guide Sep 19, 2023
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 left just some minor changes and we can merge.

docs/pages/installation.md Outdated Show resolved Hide resolved
docs/pages/installation.md Show resolved Hide resolved
@sonarcloud
Copy link

sonarcloud bot commented Sep 20, 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 21, 2023 05:59
@afzal442
Copy link
Contributor Author

/rtm

Copy link
Member

@KhudaDad414 KhudaDad414 left a comment

Choose a reason for hiding this comment

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

LGTM!

@KhudaDad414
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 880e5ee into asyncapi:master Sep 25, 2023
14 checks passed
@afzal442 afzal442 deleted the create-installation-guide branch September 25, 2023 13:04
@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.

5 participants