docs: new guide for validation of AsyncAPI files #1002
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 and @derberg, I would love your feedbacks on this. |
Annysah
changed the title
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1002--asyncapi-website.netlify.app/ |
quetzalliwrites
added
📑 docs
area/docs
pages/docs/guides/validate.md
Outdated
| - [AsyncAPI CLI](https://github.com/asyncapi/cli#installation) | ||
| - [Spectral](https://meta.stoplight.io/docs/spectral/b8391e051b7d8-installation) | ||
|
|
||
| # Create AsyncAPI documents |
There was a problem hiding this comment.
I don't think you need to explain what asyncapi is.
Turn it into a section that says: "yo, to validate AsyncAPi document, you first need to have one, right 😉 if you did not write one for your app yet, you can easily generate one using one of our examples provided in the AsyncAPI CLI" -> and then line 20-24 is good
|
Hey @Annysah, how's the next draft coming along? does Lukasz's feedback make sense to you? 😄 |
Haha 😄 yes it does. |
|
Dear @alequetzalli & @derberg, I would love your feedbacks on the update. Thank you! |
pages/docs/guides/validate.md
Outdated
| AsyncAPI provides official [JavaScript](https://github.com/asyncapi/parser-js) and [Go](https://github.com/asyncapi/parser-go) parsers for validating the JSON schema in your AsyncAPI documents. | ||
|
|
||
| <Remember> | ||
| If you do not run your schemas through the parsers, the JSON schemas alone cannot complete the entire validation. |
There was a problem hiding this comment.
| If you do not run your schemas through the parsers, the JSON schemas alone cannot complete the entire validation. |
|
@alequetzalli & @derberg, all done! |
|
Hi @derberg & @alequetzalli, I have updated the changes. |
|
|
||
| --- | ||
|
|
||
| ## Additional resources |
There was a problem hiding this comment.
do we need those if they are already linked in previous sections?
There was a problem hiding this comment.
I think it's great a way to make users access more resources from one place, i.e anyone who just wants to visit the guide can just learn more on the go.
yaay!! |
|
Approved, but we can't merge yet because the prev/next buttons point to |
quetzalliwrites
dismissed stale reviews from derberg and themself
via
397a172
|
/rtm |
Description
Related issue(s)
Fixes #994