docs: improve the template tutorial's readability #1154
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lmgyuan
requested review from
Florence-Njeri,
derberg and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
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.
lmgyuan
changed the title
lmgyuan
force-pushed
the
Edit_tutorial_Yuan
branch
from
7b6df31
to
f566231
Compare
derberg
reviewed
Apr 3, 2024
| 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. |
| Now your directory should look like this: | ||
|
|
||
| ``` | ||
| python-mqtt-client-template |
Co-authored-by: Lukasz Gornicki <[email protected]>
Florence-Njeri
approved these changes
Apr 4, 2024
|
|
/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 📦🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR is to make the tutorial documentation clearer for users to understand, as requested by @derberg : )
Related issue(s)
See also #1145