From c83bf5d1b3ab7a3c0e9b447e32e8f357cc3c8083 Mon Sep 17 00:00:00 2001 From: Cord Slatton Date: Mon, 26 Aug 2024 10:00:42 -0700 Subject: [PATCH 1/2] Cleanup steps.md Fix awkward phrasing, plurality in steps.md --- docs/build/steps/steps.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/build/steps/steps.md b/docs/build/steps/steps.md index ac31dc48470..8652bbb6d99 100644 --- a/docs/build/steps/steps.md +++ b/docs/build/steps/steps.md @@ -4,24 +4,24 @@ title: Configure Steps A Step is a specific task or activity in a workflow. Each Step is linked to an [Adaptor](/adaptors/) and contains business logic to perform a specific task or -operation in that target app. Read on to learn more. +operation in that target app. :::note In OpenFn V1, there was no concept of `Workflow Steps`--they were referred to as -`Jobs`. In V2, we now refer to Jobs as the "job expressions" or "script" that -define the business logic and transformation rules of individual `Steps`. +`Jobs`. In V2, `Jobs` now are defined as _the job expressions or script that +define the business logic and transformation rules of individual `Steps`_. ::: ## Create or edit a Step Via the Workflow Canvas, click the plus `+` icon to create a _new_ Step, or -click on existing Step to view or configure its key components. +click on ann existing Step to view or configure its key components. ## Configure the Step -When configuring a Step, you must understand its basic anatomy. +To properly configure a Step, you must understand its basic anatomy. ![Step Anatomy](/img/anatomy_of_step.png) @@ -31,8 +31,8 @@ A Step includes these key components: - `Adaptor` - The selected [Adaptor](/adaptors/) that is used to provide app-specific functionality for this Step (e.g., `dhis2` or `commcare`). - `Adaptor Version` - The version of the selected Adaptor, which determines - which API endpoints and Adaptor functions are available. See below section to - learn more. + which API endpoints and Adaptor functions are available. See below section + `Choose an Adaptor Version` to learn more. - `Credentials` - The Credential used to authorize connections to the target app related to this Step. - `Job` - The custom code that defines the business logic and/or sequence of @@ -116,12 +116,12 @@ Versions for run f470a3da-8b90-480e-a94f-6dd982c91afe: While it may be beneficial to upgrade as part of your routine maintenance, these upgrades should be carefully tested. Most often, customers upgrade to a new -adaptor version for an existing step when they are making business-drives +adaptor version for an existing step when they are already making business-driven changes to that step. Some business-driven changes may actually _require_ upgrading the version in order to use a new feature from the adaptor. Even if -those changes don't require and upgrade, if the technical team must spend time -testing step-specific changes anyway, it may be an ideal opportunity to test -also test an upgrade. +those changes don't require an upgrade, if the technical team must spend time +testing step-specific changes anyway, it may be an ideal opportunity to also test +an upgrade of the adaptor version. Adaptors follow [SEMVER](https://semver.org/) so you can be reasonably assured that upgrading from `x.1.z` to `x.2.z` will not lead to existing step code From 13e2d22374f5c0f2b62cf54d76df2d8acc1ab02b Mon Sep 17 00:00:00 2001 From: Cord Slatton Date: Fri, 13 Sep 2024 16:24:27 +0000 Subject: [PATCH 2/2] remove typo --- docs/build/steps/steps.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/steps/steps.md b/docs/build/steps/steps.md index 8652bbb6d99..18b48ae0015 100644 --- a/docs/build/steps/steps.md +++ b/docs/build/steps/steps.md @@ -17,7 +17,7 @@ define the business logic and transformation rules of individual `Steps`_. ## Create or edit a Step Via the Workflow Canvas, click the plus `+` icon to create a _new_ Step, or -click on ann existing Step to view or configure its key components. +click on an existing Step to view or configure its key components. ## Configure the Step