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

Improve documentation for example tasks. #298

Open
ndragon798 opened this issue Oct 26, 2021 · 0 comments
Open

Improve documentation for example tasks. #298

ndragon798 opened this issue Oct 26, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@ndragon798
Copy link

Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

When reading documentation for supported plugins (echo,http,subtask,ssh,etc...) the documentation lacks a full example.

Describe the solution you'd like
A clear and concise description of what you want to happen.

Include a full example like hello-world-now.yaml. A full example will give a more complete understanding of the product to new users along with proper usage and best practices(how to properly load in cred/keys from external files).

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Not much documentation exists for utask other than on github.

@ndragon798 ndragon798 added the enhancement New feature or request label Oct 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant