Repository navigation
Update and reword README.md - #5023
Merged
Merged
Conversation
arm4b
suggested changes
Aug 12, 2020
Member
|
Following the #4762 (comment), just changed the reference to the new diagram you shared. @blag is there anything else we need to merge this? |
arm4b
approved these changes
Sep 15, 2020
blag
marked this pull request as ready for review
September 15, 2020 20:28
22 of 25 tasks
amanda11
reviewed
Sep 18, 2020
| * **Rules** map triggers to actions (or to workflows), applying matching criterias and map trigger payload data to action inputs. | ||
|
|
||
| * **Workflows** stitch actions together into “uber-actions”, defining the order, transition conditions, and passing the data. Most automations are more than one-step and thus need more than one action. Workflows, just like “atomic” actions, are available in action library, can be invoked manually or triggered by rules. | ||
| * **Workflows** stitch actions together into "uber-actions", defining the order, transition conditions, and passing context data from one action to the next. Most automations are multi-step (eg: more than one action). Workflows, just like "atomic" actions, are available in the action library, and can be invoked manually or triggered by rules. |
Contributor
There was a problem hiding this comment.
In the workflows then shouldn't eg: be eg. ?
Contributor
There was a problem hiding this comment.
The correct form for the "For example" abbreviation is e.g.
Member
nmaludy
reviewed
Sep 29, 2020
| * **Rules** map triggers to actions (or to workflows), applying matching criterias and map trigger payload data to action inputs. | ||
|
|
||
| * **Workflows** stitch actions together into “uber-actions”, defining the order, transition conditions, and passing the data. Most automations are more than one-step and thus need more than one action. Workflows, just like “atomic” actions, are available in action library, can be invoked manually or triggered by rules. | ||
| * **Workflows** stitch actions together into "uber-actions", defining the order, transition conditions, and passing context data from one action to the next. Most automations are multi-step (eg: more than one action). Workflows, just like "atomic" actions, are available in the action library, and can be invoked manually or triggered by rules. |
Member
There was a problem hiding this comment.
Suggested change
| * **Workflows** stitch actions together into "uber-actions", defining the order, transition conditions, and passing context data from one action to the next. Most automations are multi-step (eg: more than one action). Workflows, just like "atomic" actions, are available in the action library, and can be invoked manually or triggered by rules. | |
| * **Workflows** stitch actions together into "uber-actions", defining the order, transition conditions, and passing context data from one action to the next. Most automations are multi-step (e.g. more than one action). Workflows, just like "atomic" actions, are available in the action library, and can be invoked manually or triggered by rules. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I noticed that the README hadn't been updated in awhile, so I tweaked some of the language, fixed a few grammatical issues, removed the broken Slack badge, and added a few more badges.
You can see the final rendered product by looking at the
update-readmebranch:https://github.com/StackStorm/st2/tree/update-readme
TODO:
Tests(just kidding)Update screenshot and linked YouTube videoEdit: Updated TODO since I'm not going to have time to record a new YouTube video.