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: hello world tutorial for AsyncApi v3 #2004

Merged

Conversation

alaminthetrustworthy
Copy link
Contributor

@alaminthetrustworthy alaminthetrustworthy commented Jul 26, 2023

Description

  • This PR adds AsyncAPI hello world tutorial for v3, I use the document snippet from the original issue .
  • the previous examples there is no operations section that i could not be able to phrase but i try here in the image bellow.
  • cc @jonaslagoni @alequetzalli

image

Related issue(s)
fix #1857

@netlify
Copy link

netlify bot commented Jul 26, 2023

Deploy Preview for shimmering-choux-eb0798 ready!

Name Link
🔨 Latest commit b3c9b59
🔍 Latest deploy log https://app.netlify.com/sites/shimmering-choux-eb0798/deploys/654ec7c4a52ab40008fbd7cf
😎 Deploy Preview https://deploy-preview-2004--shimmering-choux-eb0798.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link

@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

@jonaslagoni jonaslagoni left a comment

Choose a reason for hiding this comment

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

Got a few comments 🙂

General comments:

  • Does not seem like the syntax: asyncapi is rendered 🤔
  • I would try not to use subscribe and publish unless the channels explicitly use an event broker, otherwise, I would keep the wording to the application receive or send something.

pages/docs/tutorials/getting-started/hello-world.md Outdated Show resolved Hide resolved
pages/docs/tutorials/getting-started/hello-world.md Outdated Show resolved Hide resolved
pages/docs/tutorials/getting-started/hello-world.md Outdated Show resolved Hide resolved
@alaminthetrustworthy
Copy link
Contributor Author

  • Does not seem like the syntax: asyncapi is rendered 🤔

hi @jonaslagoni this line i dont get which asyncapi are you referring to

@jonaslagoni
Copy link
Member

hi @jonaslagoni this line i dont get which asyncapi are you referring to

It's the ` characters, where you highlight certain words, is rendered exactly as ` instead of highlighting the word such as asyncapi
image

@alaminthetrustworthy
Copy link
Contributor Author

alaminthetrustworthy commented Aug 3, 2023

hi @jonaslagoni this line i dont get which asyncapi are you referring to

It's the characters, where you highlight certain words, is rendered exactly as instead of highlighting the word such as asyncapi image

I used the style of previous Async Hello world tutorial v2, but I will remove it

@derberg
Copy link
Member

derberg commented Nov 9, 2023

I pushed directory to @alaminthespecial branch to address missing parts. Thanks @alaminthespecial for initial hard work.

@alequetzalli ready for final review

@quetzalliwrites
Copy link
Member

/rtm

@asyncapi-bot asyncapi-bot merged commit 3b79c14 into asyncapi:next-major-spec Nov 11, 2023
10 checks passed
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