Skip to content

[📑 Docs]: add clarifying steps for Creating a Generator Template Tutorial #2107

@abeeto

Description

@abeeto

What Dev Docs changes are you proposing?

When following the Creating a Template - Python tutorial, I had to take some additional steps that were not covered in the docs that I think should be included for others.

There is mention of installing the AsyncAPI generator CLI using global flag:

`npm install -g @asyncapi/cli`

But no mention of installing the Generator tool (which from previous docs suggest to be a local, project scoped install. The generator tool is needed for the CLI to run the other commands in the tutorial. A simple line mentioning this would be useful for first timers, something like:

Run `npm install @asyncapi/generator` while still in /python-mqtt-client-template directory

Initially, I was unable to get my client to connect to the remote test MQTT broker on test.mosquitto.org. I followed the alternative approach of hosting a mosquitto broker locally with Docker. However, I faced issues running the MQTT-CLI docker command to test and verify subscribers could receive messages:

`docker run hivemq/mqtt-cli sub -t temperature/changed -h test.mosquitto.org`

For me (macOS), I had to change the host argument to point to my host machine using host.docker.internal:

`docker run hivemq/mqtt-cli sub -t temperature/changed -h host.docker.internal`

Code of Conduct

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

Are you willing to work on this issue?

Yes I am willing to submit a PR!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions