Skip to content

Conversation

starlightknown
Copy link
Contributor

Description

  • last streetlights tutorial, validation of events/messages using asyncapi

Related issue(s)

Fixes #881

@netlify
Copy link

netlify bot commented Oct 30, 2022

Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 528407f
🔍 Latest deploy log https://app.netlify.com/sites/asyncapi-website/deploys/63f93812fc68a900085210d4
😎 Deploy Preview https://deploy-preview-1061--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 30, 2022

⚡️ Lighthouse report for the changes in this PR:

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

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

@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 Nov 1, 2022

In previous tutorial, you have generated your application using [AsyncAPI Generator](https://github.com/asyncapi/generator) Node.js template.
Now you will be validating the messages/events which you will be sending to your application using Mosquitto broker and MQTT client.

Copy link
Contributor

Choose a reason for hiding this comment

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

@starlightknown Hey, you're missing the Installation Guide section. Please go ahead and add that so Lukasz can make his review. :)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hey @alequetzalli I thought of adding it but since this is the continuation of previous tutorial, we don't need any extra things to install here. Let me know your thoughts

Copy link
Contributor

@quetzalliwrites quetzalliwrites Nov 14, 2022

Choose a reason for hiding this comment

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

Nope, each tutorial needs to stand alone on its own. I wrote about this in another PR but now I can't remember in which one I left long comment 😅😂😂

Never assume that a user is going to follow a certain order in how they read documentation and never assume that they will complete tutorials in the order you list them. Each tutorial needs to stand on its own as if no other tutorial existed, which means that each tutorial needs to have its own installation information for whatever the user needs in that particular tutorial.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Okay I'll add that

Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

I think it is important that this new document relates to document introduced by #1025

In this tutorial, you'll learn how to validate messages/events which are sent to your application using AsyncAPI.

# Background Context
A message broker is software that enables applications, systems, and services to communicate with each other and exchange information, in this case messages/events.
Copy link
Member

Choose a reason for hiding this comment

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

this is a context about brokers, but article is about events validation, so IMHO context should be only provided in context of events validation. Kinda reference you the guide you are working on. And explanation that in this tutorial you can see an example of validation that happens in application runtime

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I made the changes in background context

{`npm start`}
</CodeBlock>

2. Now let's try to send a message:
Copy link
Member

Choose a reason for hiding this comment

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

👏🏼
love idea with the reference to message payload

starlightknown and others added 7 commits November 9, 2022 19:43
Co-authored-by: Alejandra Quetzalli  <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli  <alejandra.olvera.novack@gmail.com>
Co-authored-by: Alejandra Quetzalli  <alejandra.olvera.novack@gmail.com>
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

should I make another review round?

I think next/prev buttons are missing

@@ -0,0 +1,72 @@
---
title: messages/events validation
Copy link
Member

Choose a reason for hiding this comment

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

I guess we can just stick with one name, Messages (upper case) in all documents as they reflect AsyncAPI spec and message property that is used there to describe message/event

Copy link
Contributor

Choose a reason for hiding this comment

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

Love this.

Copy link
Contributor

Choose a reason for hiding this comment

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

On that note, let's make sure we update the FILE NAME in this PR to message-validation.

Copy link
Contributor

@quetzalliwrites quetzalliwrites left a comment

Choose a reason for hiding this comment

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

Good catch/reminder from Lukaszzzz to please add the prev/next buttons to this PR. 🙏

akshatnema
akshatnema previously approved these changes Dec 21, 2022
Copy link
Member

@akshatnema akshatnema left a comment

Choose a reason for hiding this comment

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

Approved! Just make sure it is merged at right time.

akshatnema
akshatnema previously approved these changes Jan 25, 2023
Copy link
Member

@akshatnema akshatnema left a comment

Choose a reason for hiding this comment

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

Approved ✔️. Great contributions @starlightknown 🥳.

derberg
derberg previously approved these changes Jan 31, 2023
Copy link
Member

@derberg derberg left a comment

Choose a reason for hiding this comment

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

great work, just remember to have it cross-linked with the validation guide

Copy link
Contributor

yes! i will add that too then @derberg

@quetzalliwrites quetzalliwrites dismissed stale reviews from derberg, akshatnema, and themself via d7f9283 February 8, 2023 04:14
@quetzalliwrites
Copy link
Contributor

great work, just remember to have it cross-linked with the validation guide

done @derberg

@quetzalliwrites
Copy link
Contributor

/rtm

@asyncapi-bot asyncapi-bot merged commit d003971 into asyncapi:master Feb 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Status: Done 🚀
Development

Successfully merging this pull request may close these issues.

[📑 Docs]: NEW tutorial, "How to validate code messages/events with AsyncAPI"
5 participants