-
-
Notifications
You must be signed in to change notification settings - Fork 911
docs: new tutorial validation of messages/events #1061
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.
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
Conversation
✅ Deploy Preview for asyncapi-website ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-1061--asyncapi-website.netlify.app/ |
|
||
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. | ||
|
There was a problem hiding this comment.
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. :)
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this 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. |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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
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>
There was a problem hiding this 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 |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Love this.
There was a problem hiding this comment.
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
.
There was a problem hiding this 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. 🙏
There was a problem hiding this 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.
a637c91
There was a problem hiding this 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 🥳.
There was a problem hiding this 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
yes! i will add that too then @derberg |
d7f9283
done @derberg |
/rtm |
Description
Related issue(s)
Fixes #881