docs: new tutorial "create asyncapi documents" #1023
Conversation
Annysah
requested review from
quetzalliwrites and
asyncapi-bot-eve
as code owners
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
|
Hello @alequetzalli & @derberg , I would love your feedbacks |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1023--asyncapi-website.netlify.app/ |
|
Thanks @derberg! |
quetzalliwrites
added
📑 docs
area/docs
quetzalliwrites
changed the title
Co-authored-by: Akshat Nema <76521428+akshatnema@users.noreply.github.com>
Co-authored-by: Akshat Nema <76521428+akshatnema@users.noreply.github.com>
|
it has been a while, sorry but I need to clarify in case of tutorials, didn't we agree that there will always be a CLI command (maybe also studio instruction) that will instruct how to perform tutorial steps? so in the end you can just do something like https://github.com/asyncapi/website/pull/1061/files#diff-8e9be9eabe193de3ae63ce37ae40ca0ab76e4567ed323f605572fa788f48da97R17-R27 that you can see here https://deploy-preview-1061--asyncapi-website.netlify.app/docs/tutorials/message-validation#background-context |
added, we're ready for review again @derberg |
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
|
You wrote "this tutorial is about creating asyncapi document, no generation should be mentioned", but then you proceed to add a commit with the word
Nice catch tho so thank you... and I fixed it for real 😄✌🏽 |
| Go ahead to create the specification documents titled `asyncapi` with a `.yaml` extension. | ||
|
|
||
| <CodeBlock> | ||
| {`asyncapi: '2.5.0' |
There was a problem hiding this comment.
| {`asyncapi: '2.5.0' | |
| {`asyncapi: '2.6.0' |
We need to have the latest version of AsyncAPI in Docs.
| Let's break it down into pieces: | ||
|
|
||
| <CodeBlock> | ||
| {`asyncapi: '2.5.0' |
There was a problem hiding this comment.
| {`asyncapi: '2.5.0' | |
| {`asyncapi: '2.6.0' |
same here...
| This tutorial is only a bootstrap; you'll need to add your own business logic into it. Take some time to play with it. There are still lots of things to be covered, but the intent of this tutorial is to make it simple for you to get an idea of the potential. | ||
|
|
||
| ## Next steps | ||
| Now that you've completed this tutorial, go ahead to learn how to [validate your AsyncAPI document with Studio](https://www.asyncapi.com/docs/tutorials/studio-document-validation). |
There was a problem hiding this comment.
| Now that you've completed this tutorial, go ahead to learn how to [validate your AsyncAPI document with Studio](https://www.asyncapi.com/docs/tutorials/studio-document-validation). | |
| Now that you've completed this tutorial, go ahead to learn how to [validate your AsyncAPI document with Studio](/docs/tutorials/studio-document-validation). |
Also, I think @alequetzalli, you have to make a special dedicated PR to align the Next Steps of each page in Docs, after merging all the Doc pages of gsod 😅. I'm very much confused about the sequence in which pages will be connected, but hope so, it is very much clear to you at the end 😄.
There was a problem hiding this comment.
they are all ready, i already fixed them :P :)
There was a problem hiding this comment.
I don't think you pushed changed
There was a problem hiding this comment.
I mean pushed changed related to the link https://www.asyncapi.com/docs/tutorials/studio-document-validation
|
/rtm |
Description
Related issue(s)
Fixes #850