Open atompie opened 11 months ago
I want to work on this issue. Please assign it to me.
Hello, @akashroy1 ! This issue describes a generic task. In order for you to be able to make a PR you must create an issue in github repository https://github.com/Tracardi/tracardi. If you're interested in documenting a specific plugin, please open an issue on GitHub. Specify the plugin you wish to document, and I will label it as "hacktoberfest" and assign it to you. This way when you merge a PR it will be counted to you hacktoberfest score. BTW you can create multiple task if you would like to work on multiple documentations.
Is your feature request related to a problem? Please describe. Some action plugins in the system are missing the documentation. We have plenty of undocumented plugins. This issue can be solved by many contributors.
Task Description:
Add Documentation as a Comment:
Save Documentation as MD File:
docs/flow/actions
in the Tracardi API GitHub repository. (See other documentations in: https://github.com/Tracardi/tracardi-api/tree/master/docs/flow/actions). Save it in a 0.8.2-dev branch. Only changes to this branch will be accepted.Naming Convention:
list_github_issues.md
).Markdown Format:
How to start
This issue describes a generic task. In order for you to be able to make a PR you must create an issue in github repository https://github.com/Tracardi/tracardi. If you're interested in documenting a specific plugin, please open an issue on GitHub. Describe the plugin you wish to document, tag me or make a comment and tag me (@atompie) and I will label it as "hacktoberfest" and assign it to you. This way when you merge a PR it will be counted to you hacktoberfest score. BTW you can create multiple task if you would like to work on multiple documentations.
Note: This documentation will be a valuable resource for users and contributors of the Tracardi platform.
To get started watch this video
https://github.com/Tracardi/tracardi/assets/16271564/539a9522-efc3-4a0d-b16c-ce3c0e886a53
https://github.com/Tracardi/tracardi/assets/16271564/29fd85d2-1718-4aa8-b361-48d49f8f5dd0