-
-
Notifications
You must be signed in to change notification settings - Fork 229
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
docs: create generator template tutorial #978
docs: create generator template tutorial #978
Conversation
@derberg @thulieblack I have put up a PR for the tutorial |
Awesome, thanks Florence |
yo, is this ready for final review? |
@pratik2315 can you have a look 🙏🏼 since it is based on my article I have a feeling better if you review first |
It is |
Hey, @Florence-Njeri the PR looks great, I have additional things to add:
counter = 0
while counter < 10:
randomId = randrange(min_value, max_value + 1)
client.sendTemperatureDrop(randomId)
print("Temperature drop detected " + str(randomId) + " sent to temperature/dropped")
client.sendTemperatureRise(randomId)
print("Temperature rise detected " + str(randomId) + " sent to temperature/risen")
time.sleep(1)
counter += 1 This loop stops after 10 intervals what do you think? |
@Florence-Njeri I'll jump into review once you apply feedback from @thulieblack |
2nd PR review Co-authored-by: V Thulisile Sibanda <[email protected]> Co-authored-by: Lukasz Gornicki <[email protected]>
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.
How about we simplify the title to Generator Template, since the first paragraph already explains that we are creating a simple generator template
you mean title of the doc? tutorials should have a title that says what it is about
Generator Template
says it is about generator template
Creating a simple generator template
says it is about creating a simple generator
We also should be consistent with other titles of the docs on the website.
Mmmh I see, then I guess we can go with |
sounds good to me, as also word @Florence-Njeri ready for final round? |
Hey @thulieblack I was running it in localhost. How do I get a preview link 🤔 |
Yes it is |
there is no quick way unfortunately. The only one I know for now is that you use GitPod to get a virtual env for website:
|
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.
docs/generator_template.md
Outdated
|
||
## Where to go from here? | ||
|
||
Great job completing this tutorial! You have learnt how to use an AsyncAPI file to create a Python MQTT template and used it with the Paho-MQTT library in Python to connect to an MQTT broker and publish messages.:] |
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.
:]
is this one intended? you can use real emoji if you want
Co-authored-by: Lukasz Gornicki <[email protected]>
…ub.com/Florence-Njeri/generator into 943-create-generator-template-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.
LGTM
@thulieblack anything from your side?
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.
Looks great from my side, well done @Florence-Njeri
We need @pratik2315 approval but he is completely unreachable, tried in the past slack - email - twitter just sent invite to LinkedIn if we will not respond I will:
|
Kudos, SonarCloud Quality Gate passed! 0 Bugs No Coverage information |
@Florence-Njeri congrats for the amazing work 👏🏼 https://www.asyncapi.com/docs/tools/generator/generator_template (we are just a bit inconsistent as filename is when you feel in the mood, please start an issue in
|
Congratulations @Florence-Njeri, on successfully finishing the task🎉🎉. Please submit an expense on open collective to claim your bounty |
I'll create an issue and put up a follow up PR for this |
🎉 This PR is included in version 1.10.11 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
Tutorial to create a user-defined template
Related issue(s)
Fixes #943