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

plugin documentation #13

Merged
merged 1 commit into from
Nov 12, 2019
Merged

plugin documentation #13

merged 1 commit into from
Nov 12, 2019

Conversation

pablito-perez
Copy link
Contributor

  • specific documentation and examples for each builtin plugin
  • added some µTask use cases in README, to provide a better overview of the project
  • documentation about plugin development

README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -17,6 +17,13 @@

µTask allows you to model business processes in a **declarative yaml format**. Describe a set of inputs and a graph of actions and their inter-dependencies: µTask will asynchronously handle the execution of each action, working its way around transient errors and keeping a trace of all intermediary states until completion.

Here are some example usecases for µTask:
- trigger remediation commands across a farm of machines over ssh
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this example can be replaced by a more top-level example, because the first sight about the project will be "oh it's another kind of Ansible". WDYT?

pkg/plugins/builtin/http/README.md Outdated Show resolved Hide resolved
pkg/plugins/builtin/echo/README.md Outdated Show resolved Hide resolved
@w3st3ry w3st3ry added documentation Improvements or additions to documentation 🚧 WIP 🚧 Work in progress label labels Nov 12, 2019
@w3st3ry w3st3ry added this to the v1.1.0 milestone Nov 12, 2019
@w3st3ry w3st3ry removed this from Review in progress in µTask feature development Nov 12, 2019
Signed-off-by: Pablo Pérez Schröder <2639770+nomonamo@users.noreply.github.com>
Copy link
Contributor

@w3st3ry w3st3ry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGFM 👍

@pablito-perez pablito-perez merged commit e5534c1 into master Nov 12, 2019
pablito-perez added a commit that referenced this pull request Nov 12, 2019
Signed-off-by: Pablo Pérez Schröder <2639770+nomonamo@users.noreply.github.com>
pablito-perez added a commit that referenced this pull request Nov 12, 2019
Signed-off-by: Pablo Pérez Schröder <2639770+nomonamo@users.noreply.github.com>
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 🚧 WIP 🚧 Work in progress label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants