Docs updates #111
Docs updates #111
Conversation
|
|
||
| Any time the input of a step relies on the output of another step via an [Arcaflow | ||
| expression](http://127.0.0.1:8000/arcaflow/workflows/expressions/), an implicit step | ||
| relationship is established. In this case, the Arcaflow engine holds the execution of the dependent step until the output from the supplier step is available. |
There was a problem hiding this comment.
This line doesn't wrap like the others.
| It is also possible to use oneof conditions as part of the `wait_for` flow control. An | ||
| explicit relationshp between steps in a workflow in this case becomes a oneof condition | ||
| for either the requested step output or otherwise the disabled state of the step. |
There was a problem hiding this comment.
Typo: relationshp
Maybe also state that this will create an OR relationship that will allow the step to run either when the step is disabled OR when it gets the intended result.
dustinblack
force-pushed
the
docs-updates
branch
from
888c34d to
b01f01e
Compare
dustinblack
force-pushed
the
docs-updates
branch
from
880b7ec to
909f08f
Compare
| the Arcaflow engine holds the execution of the dependent step until the output from the | ||
| supplier step is available. |
There was a problem hiding this comment.
"dependent" to "supplier" sounds like an odd combination. Maybe "supplier" -> "consumer" to focus more on the data dependency?
There was a problem hiding this comment.
It may make sense to also explicitly say the step names so that the reader doesn't need to look through the workflow below to figure out which one is the dependent/comsumer step or supplier step.
| To use `!oneof` for graceful handling of disabled steps, the oneof should depend on ONE | ||
| OF the success output and the disabled output, which will output either the success | ||
| output or the disabled output. | ||
|
|
||
| The oneof tag is a method of creating a schema `one_of_string` type from values present in the workflow. | ||
| The oneof tag is a method of creating a schema `one_of_string` type from values present |
There was a problem hiding this comment.
I think the "oneof" references here should probably all be rendered as oneof so the eye isn't expecting English.
There was a problem hiding this comment.
Yeah, good point. This was missed in the prior PR. This section was only changed in width in this PR.
| the workflow to succeed when a step crashes, the optional tags could be the right | ||
| feature for your workflow. | ||
|
|
||
| The alterative methods are the "optional" family of expression tags. The `oneof` tags instructed the workflow to | ||
| build a `oneof_string` type with OR dependencies, requiring one of the options to have an output for the oneof to | ||
| resolve. Meanwhile, the "optional" family of tags can resolve without an output by utilizing optional object property | ||
| The alterative methods are the "optional" family of expression tags. The `oneof` tags |
There was a problem hiding this comment.
You introduce the concept of "optional" tags in the first paragraph, and then introduce the concept again in the following paragraph, which sounds repetitive. Maybe the final phrase of the first paragraph should be "there are alternative methods." Or else drop "The alternative methods are" from the follow-up and just start explaining the "optional" family. (And "optional" family seems better than "optional tags", which suggests the English concept "optional" rather than the keywords representing optional dependencies in the workflow. 😆 )
| the Arcaflow engine holds the execution of the dependent step until the output from the | ||
| supplier step is available. |
There was a problem hiding this comment.
It may make sense to also explicitly say the step names so that the reader doesn't need to look through the workflow below to figure out which one is the dependent/comsumer step or supplier step.
|
|
||
| ## Explicit Step Relationships | ||
|
|
||
| Sometimes it is important to serialize workflow steps even if they do not have a data |
There was a problem hiding this comment.
To make it clear what we mean by serialize the steps, I would say "serialize the order of workflow steps" instead.
| To use `!oneof` for graceful handling of disabled steps, the oneof should depend on ONE | ||
| OF the success output and the disabled output, which will output either the success | ||
| output or the disabled output. | ||
|
|
||
| The oneof tag is a method of creating a schema `one_of_string` type from values present in the workflow. | ||
| The oneof tag is a method of creating a schema `one_of_string` type from values present |
There was a problem hiding this comment.
Yeah, good point. This was missed in the prior PR. This section was only changed in width in this PR.
Changes introduced with this PR
Some fixes and cleanup of the getting started guide, and some expansion of the flow control docs.
By contributing to this repository, I agree to the contribution guidelines.