-
-
Notifications
You must be signed in to change notification settings - Fork 210
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: improve the template tutorial's readability #1154
Conversation
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.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
7b6df31
to
f566231
Compare
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.
thanks, tutorial got more explicit, I especially like the approach with showing directory structure
there are 2 comments @lmgyuan you need to address
5. Create a new file named **index.js** in your **template** directory. This file is used to define the **logic** for your template. | ||
6. Create a **test.py** file to validate the logic of your application. | ||
3. Create a new folder **test/fixtures** with a file named **asyncapi.yml** in your fixtures directory. This file is used to define the **structure** of your template. You can copy the above template and paste it in your **asyncapi.yml** file. | ||
4. Create a new file named **package.json** in your **python-mqtt-client-template** directory. This file is used to define the **dependencies** for your template. |
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.
yup, good 👁️
Now your directory should look like this: | ||
|
||
``` | ||
python-mqtt-client-template |
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.
👏🏼
Co-authored-by: Lukasz Gornicki <lpgornicki@gmail.com>
|
/rtm |
@allcontributors please add @lmgyuan for docs |
I've put up a pull request to add @lmgyuan! 🎉 |
🎉 This PR is included in version 1.17.21 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Description
This PR is to make the tutorial documentation clearer for users to understand, as requested by @derberg : )
Related issue(s)
See also #1145