Skip to content

docs: new tutorial "validate asyncapi documents using studio" #1022

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 65 commits into from
Feb 24, 2023
Merged

docs: new tutorial "validate asyncapi documents using studio" #1022

merged 65 commits into from
Feb 24, 2023

Conversation

starlightknown
Copy link
Contributor

Description

  • NEW tutorial, "How to Validate AsyncAPI documents using studio"

Related issue(s)

#872

@netlify
Copy link

netlify bot commented Oct 14, 2022 •
edited
Loading

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 3b84f28
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/63f935fba230370008eee6c0
😎 Deploy Preview https://deploy-preview-1022--asyncapi-website.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 settings.

@github-actions
Copy link

github-actions bot commented Oct 14, 2022 •
edited
Loading

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 58
🟠 Accessibility 88
🟢 Best practices 100
🟢 SEO 100
🔴 PWA 30

Lighthouse ran on https://deploy-preview-1022--asyncapi-website.netlify.app/

@starlightknown
Copy link
Contributor Author

@alequetzalli this is up for suggestions and reviews

@starlightknown starlightknown changed the title docs: validate asyncapi documents using studio docs: new tutorial validate asyncapi documents using studio Oct 15, 2022
derberg
derberg reviewed Oct 20, 2022
View reviewed changes
pages/docs/tutorials/validate-documents Outdated
@@ -0,0 +1,144 @@
---
Copy link
Member

Choose a reason for hiding this comment

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

you need to add .md to file name as now it do not show up in the preview

@starlightknown
added .md
eaa78b1 
changed name
@quetzalliwrites quetzalliwrites added 📑 docs area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. gsod This label should be used for issues or discussions related to ideas for Google Season of Docs labels Oct 24, 2022
@quetzalliwrites
Merge branch 'master' into studio
62c0274
@quetzalliwrites
re-wrote content into tutorial writing format
372ddf0 
There was a lot of unnecessary info that was not relevant to the core goal of the tutorial. The tutorial was also missing a sequential format from start to finish.
@quetzalliwrites quetzalliwrites requested review from derberg and removed request for fmvilas and mcturco October 26, 2022 01:32
@quetzalliwrites
Copy link
Contributor

quetzalliwrites commented Oct 26, 2022 •
edited
Loading

📝 Hey @starlightknown, a few feedback notes:

  1. This tutorial had a lot of unnecessary content that was directly copied over from the 'guide' PR. This should have been rewritten entirely and edited to be much more succinct. (Ex: mention of diff ways to validate, writing a description of an AsyncAPI document and its sections (we already have a Quickstart), and even talking about parsers)
  2. This tutorial was not written in only sequential format, guiding us from steps 1-10. I re-wrote this content to show how tutorial steps should be written.

At this point, it would be great to have @derberg review it from a technical perspective and provide his feedback too on how to further improve this tutorial. I am curious to see if he thinks we should add more errors and what they might be. (I considered making an error in the Payload section (a number instead of the required string for email?) but wasn't 100% sure.

Thank you for all your work so far, Karuna! ✨✨✨✨

@quetzalliwrites quetzalliwrites changed the title docs: new tutorial validate asyncapi documents using studio docs: new tutorial "validate asyncapi documents using studio" Oct 26, 2022
@quetzalliwrites
Copy link
Contributor

Oh and we need add the Prev/Next steps buttons to this doc page too :)

@starlightknown
Copy link
Contributor Author

hey @starlightknown, where is that comment added to the Studio invalid template example? can you please show me link to that

asyncapi/studio#536 it's not merged yet

@magicmatatjahu
Copy link
Member

@starlightknown @alequetzalli Should I merge the PR in Studio first or I should wait for this PR?

@quetzalliwrites
Copy link
Contributor

@starlightknown @alequetzalli Should I merge the PR in Studio first or I should wait for this PR?

@magicmatatjahu I recommend we wait to merge asyncapi/studio#536 at the same time as this tutorial PR; otherwise, it will confuse users since the tutorial won't be live yet.

@magicmatatjahu
Copy link
Member

@alequetzalli Mentioned PR is already merged 😅 You can merge this one with one problem.

@quetzalliwrites
Copy link
Contributor

@alequetzalli Mentioned PR is already merged 😅 You can merge this one with one problem.

LOL !! yeah I see fran got excited and jumped the gun to merge...

So you say "You can merge this one with one problem." Sorry, what problem is that? 🧐

akshatnema
akshatnema reviewed Jan 25, 2023
View reviewed changes
@quetzalliwrites @akshatnema
Update pages/docs/tutorials/validate-documents.md
94dda70 
Co-authored-by: Akshat Nema <76521428+akshatnema@users.noreply.github.com>
@quetzalliwrites
fixed file name
cbc78d0 
file name didn't include tutorial validation method
@quetzalliwrites quetzalliwrites mentioned this pull request Jan 27, 2023
Closed
1 task
@quetzalliwrites
Copy link
Contributor

/rtm

@asyncapi-bot asyncapi-bot merged commit 313ce70 into asyncapi:master Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@asyncapi-bot-eve asyncapi-bot-eve Awaiting requested review from asyncapi-bot-eve asyncapi-bot-eve is a code owner

@derberg derberg Awaiting requested review from derberg

@akshatnema akshatnema Awaiting requested review from akshatnema

2 more reviewers

@magicmatatjahu magicmatatjahu magicmatatjahu left review comments

@quetzalliwrites quetzalliwrites quetzalliwrites approved these changes

Reviewers whose approvals may not affect merge requirements
Assignees

@starlightknown starlightknown

Labels
area/docs Specify what technical area given issue relates to. Its goal is to ease filtering good first issues. 📑 docs gsod This label should be used for issues or discussions related to ideas for Google Season of Docs ready-to-merge
Projects
AsyncAPI Docs Board
Status: Done 🚀
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: NEW tutorial, "How to validate AsyncAPI documents"
6 participants
@starlightknown @quetzalliwrites @akshatnema @derberg @magicmatatjahu @asyncapi-bot