docs icon indicating copy to clipboard operation
docs copied to clipboard

Guides not sufficiently explaining how to use specific plugins

Open Adematics opened this issue 1 year ago • 4 comments

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:

### Tasks
- [x] https://kestra.io/docs/how-to-guides/conditional-branching
- [ ] https://kestra.io/docs/how-to-guides/loop
- [ ] https://kestra.io/docs/how-to-guides/multiplecondition-listener

Adematics avatar Sep 18 '24 14:09 Adematics

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)

Ben8t avatar Sep 18 '24 15:09 Ben8t

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.

Adematics avatar Sep 18 '24 15:09 Adematics

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 ?

Ben8t avatar Sep 18 '24 15:09 Ben8t

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

Adematics avatar Sep 19 '24 13:09 Adematics

Hello, If this issue is still active may i get assigned for the rest of the tasks?

Dev-Aditya-More avatar Oct 17 '24 17:10 Dev-Aditya-More

Hello, If this issue is still active may i get assigned for the rest of the tasks?

you can work on the last one, am almost done with the second. @Dev-Aditya-More

Adematics avatar Oct 17 '24 19:10 Adematics

Great, thanks for the update! I'll get started on the last task now.

Dev-Aditya-More avatar Oct 17 '24 19:10 Dev-Aditya-More

Hi, I've finished adding the tutorial for the Multiple Condition Listener. Should I go ahead and open a pull request for it?

Dev-Aditya-More avatar Oct 18 '24 08:10 Dev-Aditya-More

@Dev-Aditya-More yes please do ! Thanks, we'll review :)

Ben8t avatar Oct 18 '24 08:10 Ben8t

yeah, pls review the pull request!

Dev-Aditya-More avatar Oct 18 '24 08:10 Dev-Aditya-More

Can you link it here whenever you have something to share? Thanks :)

Ben8t avatar Oct 18 '24 08:10 Ben8t

Sure! Here’s the link: (pull request) Let me know if there's a change you want me to make. Thanks for reviewing!

Dev-Aditya-More avatar Oct 18 '24 09:10 Dev-Aditya-More