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

Add hello-world example #3

Merged
merged 4 commits into from Apr 3, 2019
Merged

Add hello-world example #3

merged 4 commits into from Apr 3, 2019

Conversation

@fmvilas
Copy link
Member

fmvilas commented Apr 1, 2019

What?

It adds an example of how to create a Hello World AsyncAPI document.

Why?

This is part of the getting started guide I'd like to write for version 2.

Notes

The reason I'm using code blocks like <pre class="language-yaml line-numbers" data-line="4-7"><code> is because it allows me to highlight lines on the code block. See an example:

Screen Shot 2019-04-01 at 15 13 37

Request for Help

Can someone help me adding better explanations and improving the introduction paragraph? Please, remember this is a Hello World and we should be very concise and straight to the point.

@@ -33,9 +33,9 @@ channels:
type: string
pattern: '^hello .+$'</code></pre>

The first line tells us this is an AsyncAPI document and it's using version 2.0.0 of the specification. This line doesn't have to be the first one but it's a recommended practice.
The first line of the specification starts with the document type (AsyncAPI) and the version (2.0.0) as a recommended practice.

This comment has been minimized.

Copy link
@fmvilas

fmvilas Apr 3, 2019

Author Member

@lifewingmate I meant the recommended practice is to put this line as the first one. However, the line is mandatory. It just doesn't have to be the first.

fmvilas added 2 commits Apr 3, 2019
@fmvilas fmvilas merged commit 9da1549 into develop Apr 3, 2019
@fmvilas fmvilas deleted the add-hello-world branch Apr 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.