Create documentation for plugins (video tutorial included)

[atompie]

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:

1. Generate Documentation:
   • Create comprehensive documentation for the specified Tracardi plugin based on the provided template. Find plugin that is missing (see below how). Use this template as a reference:

Delete vector

Deletes a vector with a defined ID in the Weaviate schema.

Description

The Delete vector plugin is used to delete a vector with a specified ID from the Weaviate schema. It connects to the Weaviate instance and deletes the vector associated with the given ID. This plugin is useful for removing vectors that are no longer needed or updating existing vectors in the Weaviate schema.

This documentation is for version 0.8.1 of the Delete vector plugin.

Inputs and Outputs

This plugin has one input:

- payload: This port accepts a payload object.

This plugin has two outputs:

- result: Returns the response from Weaviate if the vector deletion is successful. The response contains the data UUID of the deleted vector.
- error: Returns an error message if an error occurs during the execution of the plugin.

Configuration
The Delete vector plugin has the following configuration parameters:

- Weaviate Resource: Select the Weaviate resource from the available options. This resource represents the Weaviate vector store.
- Schema class: Select the schema class from which the vector will be deleted. This class represents the type of data associated with the vector.
- Object ID: Type or reference the ID of the object for which the vector should be deleted. The object ID is required when deleting data from the schema.
- Required resources
This plugin requires the configuration of a Weaviate resource. The Weaviate resource represents the connection information and credentials required to access the Weaviate instance.

Errors
The Delete vector plugin may encounter the following error:

Error: This error occurs when an exception is raised during the execution of the plugin. The error message provides more information about the specific error that occurred.
Note: The error message will be returned in the error output port.

2. Add Documentation as a Comment:

   • Add the generated documentation as a comment to the this issue. This step is crucial for informing others about the progress made in documenting the plugins.

3. Save Documentation as MD File:

   • Save the documentation as a Markdown (MD) file in the following folder: 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.

4. Naming Convention:

   • Name the MD file according to the plugin's name, adhering to the following conventions:
     • If the plugin name contains spaces (e.g., "List GitHub Issues"), replace spaces with underscores and add the ".md" extension (e.g., list_github_issues.md).

5. Markdown Format:

   • Ensure that the documentation is properly formatted using Markdown syntax. Include relevant sections such as introduction, configuration options, usage instructions, and any other pertinent details.

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

[akashroy1]

I want to work on this issue. Please assign it to me.

[atompie]

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.