Guides not sufficiently explaining how to use specific plugins

kestra-io / docs

Documentation for Kestra — an event-driven, language-agnostic orchestration and scheduling platform to manage millions of workflows declaratively in code.

https://kestra.io/docs

81 stars 96 forks source link

Guides not sufficiently explaining how to use specific plugins #1744

Open Adematics opened 2 months ago

Adematics commented 2 months ago

Description

Some of the how-to guides on the Kestra documentation page do not provide enough guidance on how to use the specific plugins they are meant to cover. Users may find it challenging to follow along due to the lack of detailed step-by-step instructions, example workflows, or plugin configuration options.

It would be helpful to enhance these guides by including:

Detailed step-by-step instructions on use cases,
Example workflows with context on when to use the plugin

Specifically, the following guides could benefit from such improvements:

Ben8t commented 2 months ago

Hello, thanks for opening this issue !

Do you have concrete examples you would like to see for these guides? I mean, there are already several blueprints or blog posts covering most of the one you mentioned.

(conditional branching -> switch and if) (loop or parallel blueprints ( multiple condition/triggers)

Adematics commented 2 months ago

Hello, thank you for your response!

While I appreciate the existing blueprints and blog posts, I noticed that some of the plugin-related guides lack in-depth, step-by-step examples that could help users implement these plugins effectively. I personally don't have a specific example use case, but I believe the how-to guides could use some improvements to better guide users in utilizing the plugins.

As it stands, the guides I listed seem more like sample blueprints rather than detailed guides. Providing more explanation on the plugins, common use cases, and example workflows (existing blueprints can be linked to the conclusion of the guide for the user to learn more) would make them more accessible for users who are new to Kestra or unfamiliar with these specific plugins.

Ben8t commented 2 months ago

Ok thanks for your clarification ! Maybe it's a matter of improving the introductions of such pages with some example use cases (as these plugins are quite core to Kestra, they address tons of use cases) Are you open to contribute and open PR ?

Adematics commented 2 months ago

Yeah, I can find some time to work on it. You can assign the issue to me.