website

website copied to clipboard

Tutorial Inconsistency

I was following this tutorial link (https://www.asyncapi.com/docs/tutorials/studio-document-validation) to complete the Studio beta Invalid Document tutorial. The link seems outdated because the vast majority of errors in the document are not even mentioned in the tutorial. That's not actually very helpful for a tutorial, because there are 5 remaining unaddressed errors that I don't know how to solve and can't find the info for. A tutorial should be easy to follow and educational. I feel that by not addressing a majority of the errors (5) that it isn't as educational as it should be.

Also, within the Studio Invalid Document there is a link to a tutorial. (https://www.asyncapi.com/docs/tutorials/validate-documents) It results in an error 404, so is not working. It needs to be updated to the correct link.

Code of Conduct

• [X] I agree to follow this project's Code of Conduct

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

Hey @KD117, thanks for raising this issue. Please update the Issue title to have better visibility for everyone.

Pinging @alequetzalli here to inform her about this issue.

Echoing what @akshatnema said, thank you for voicing your experience and feedback!

I agree we can improve this tutorial and address the remaining errors. Would you like to contribute your time to work on this issue? @KD117

fyi @starlightknown, thoughts? 😄

fyi @starlightknown, thoughts? 😄

yes, this could use some improvement, I can find out more errors and try to document them. Last time we did, I think it was only for the major ones

do you feel open to picking it up, @starlightknown? (assuming we don't hear back from @KD117) 😄

Yep I'll pick it if they don't reply

Hello all! @starlightknown @alequetzalli My apologies, I am very new to this! We work mostly within GitLab at work, and I'm not as familiar with GitHub. How can I help? I could use some direction please. Thanks.

Hey, @KD117! All good. Just send a slack DM to me and Karuna (@starlightknown) in the AsyncAPI Slack workspace! 😄

After we sync, Karuna can team with you to identify the errors still showing and you can work together to document them. Together, we can improve this tutorial ✨💪🏿

https://join.slack.com/t/asyncapi/shared_invite/zt-1qtqe55z8-MYicDv4AB7PP6bn44g6ZrQ

This issue has been automatically marked as stale because it has not had recent activity :sleeping:

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience :heart:

Hey @alequetzalli :wave:

An update on this issue. After following the tutorial, I'm getting the following message from the diagnostics box

---

Also, within the Studio Invalid Document there is a link to a tutorial. (https://www.asyncapi.com/docs/tutorials/validate-documents) It results in an error 404, so is not working. It needs to be updated to the correct link.

I've opened an issue and following PR to address this in the Studio repo.