docs: create generator template tutorial

[Florence-Njeri]

Description
Tutorial to create a user-defined template

Related issue(s)
Fixes #943

[Florence-Njeri]

@derberg @thulieblack I have put up a PR for the tutorial

[thulieblack]

Awesome, thanks Florence

[derberg]

yo, is this ready for final review?

[derberg]

@pratik2315 can you have a look 🙏🏼 since it is based on my article I have a feeling better if you review first

[Florence-Njeri]

yo, is this ready for final review?

It is

[thulieblack]

Hey, @Florence-Njeri the PR looks great, I have additional things to add:

1. while running the npm test there was an error that required rimraf package. I think we should add that to the tutorial as well.
2. The Python loop is continual it doesn't stop running. so I suggest we add a counter to stop the while statement after certain intervals for instance

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?

[derberg]

@Florence-Njeri I'll jump into review once you apply feedback from @thulieblack

[thulieblack]

1. How about we simplify the title to Generator Template, since the first paragraph already explains that we are creating a simple generator template

In this tutorial, you'll learn to create a simple generator template using a Python MQTT client.

[derberg]

@thulieblack

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.

[thulieblack]

Mmmh I see, then I guess we can go with Creating a Generator Template

[derberg]

sounds good to me, as also word simple is no good for titles

@Florence-Njeri ready for final round?

[Florence-Njeri]

yo @Florence-Njeri can you share the preview link here as well

Hey @thulieblack I was running it in localhost. How do I get a preview link 🤔

[Florence-Njeri]

sounds good to me, as also word simple is no good for titles

@Florence-Njeri ready for final round?

Yes it is

[derberg]

Hey @thulieblack I was running it in localhost. How do I get a preview link

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:

1. go here http://gitpod.io/#https://github.com/asyncapi/website
2. manually put new markdown in a desired location
3. stop server and run there again npm run dev
4. in logs you see localhost link, click it, and it will get you to a separate website like https://3000-asyncapi-website-q3b1xuns0yu.ws-eu101.gitpod.io/docs/tools/generator/generator-template

[derberg]

just 2 small comments

and regarding navigation, maybe under Template your code section, all subsections should also have number, so in navigation it then makes more sense? something like:

[derberg]

:]

is this one intended? you can use real emoji if you want

[derberg]

LGTM

@thulieblack anything from your side?

[thulieblack]

Looks great from my side, well done @Florence-Njeri

[derberg]

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:

• merge as admin, ignoring his lack of approval
• and we need to remove him as a maintainer

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

[derberg]

@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 generator_template and all other have -) and now when I'm thinking, since it is generator docs, the document title could probably be just Creating a template 😄
@thulieblack thanks a lot for help with review, I guess you can share with @Florence-Njeri how to get the bounty

when you feel in the mood, please start an issue in website repo to discuss if there is a need for content buckets for tools long term, as we have this use case where we have lots of docs, but as flat list:

• we have no way to visualize that something is a tutorial
• but we have a use case that it is very tool specific/oriented tutorial and it cannot be in the main "tutorials" bucket

[thulieblack]

Congratulations @Florence-Njeri, on successfully finishing the task🎉🎉. Please submit an expense on open collective to claim your bounty

[Florence-Njeri]

@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 generator_template and all other have -) and now when I'm thinking, since it is generator docs, the document title could probably be just Creating a template 😄 @thulieblack thanks a lot for help with review, I guess you can share with @Florence-Njeri how to get the bounty

when you feel in the mood, please start an issue in website repo to discuss if there is a need for content buckets for tools long term, as we have this use case where we have lots of docs, but as flat list:

• we have no way to visualize that something is a tutorial
• but we have a use case that it is very tool specific/oriented tutorial and it cannot be in the main "tutorials" bucket

I'll create an issue and put up a follow up PR for this

[asyncapi-bot]

🎉 This PR is included in version 1.10.11 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀