Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Guides not sufficiently explaining how to use specific plugins #1744

Open
2 of 3 tasks
Adematics opened this issue Sep 18, 2024 · 12 comments
Open
2 of 3 tasks

Guides not sufficiently explaining how to use specific plugins #1744

Adematics opened this issue Sep 18, 2024 · 12 comments
Labels
documentation Improvements or additions to documentation good first issue Great issue for new contributors

Comments

@Adematics
Copy link
Contributor

Adematics commented Sep 18, 2024

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

@Adematics Adematics added the documentation Improvements or additions to documentation label Sep 18, 2024
@kestrabot kestrabot bot added this to Issues Sep 18, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Issues Sep 18, 2024
@Ben8t
Copy link
Member

Ben8t commented Sep 18, 2024

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
Copy link
Contributor Author

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
Copy link
Member

Ben8t commented Sep 18, 2024

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
Copy link
Contributor Author

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

@Dev-Aditya-More
Copy link
Contributor

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

@Adematics
Copy link
Contributor Author

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

@Dev-Aditya-More
Copy link
Contributor

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

@Dev-Aditya-More
Copy link
Contributor

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

@Ben8t
Copy link
Member

Ben8t commented Oct 18, 2024

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

@Dev-Aditya-More
Copy link
Contributor

yeah, pls review the pull request!

@Ben8t
Copy link
Member

Ben8t commented Oct 18, 2024

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

@Dev-Aditya-More
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Great issue for new contributors
Projects
Status: Backlog
Development

No branches or pull requests

4 participants