From d17bb1d24fd455dc1e5a1618ffcbcd544a0f50a4 Mon Sep 17 00:00:00 2001 From: Cord Slatton Date: Fri, 23 Aug 2024 16:10:28 -0700 Subject: [PATCH 1/2] Update cli-usage.md --- docs/build-for-developers/cli-usage.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/build-for-developers/cli-usage.md b/docs/build-for-developers/cli-usage.md index 7cdef3c3176..dc599bc661e 100644 --- a/docs/build-for-developers/cli-usage.md +++ b/docs/build-for-developers/cli-usage.md @@ -4,10 +4,15 @@ sidebar_label: Basic usage slug: /cli-usage --- -This page shows common usage examples for the CLI. +This page shows examples for some of the most common usages of the CLI, such as: -Execute a job, run a workflow, adjust logging, maintain adaptors, and save the -state. +- get help +- run a job +- saving the state +- adjust logging level +- maintain adaptors repo +- run a workflow +- load adaptor documentation --- @@ -25,9 +30,8 @@ openfn deploy --help ### Run a job -To run a single job, you must explicitly specify which adaptor to use. You can -find the list of publicly available [adaptors here](/adaptors). See examples -below. +To run a single job, you must explicitly specify which adaptor to use. +[Publicly available adaptors](/adaptors). See examples below. Adaptors are automatically installed if the specified version is not detected. @@ -173,8 +177,8 @@ openfn repo clean ### Run a workflow -
- A workflow has a structure like this +
+ A workflow has a structure like this: ```json { From e2483d1f10a3624d8257d79a7409c13029237ad7 Mon Sep 17 00:00:00 2001 From: Cord Slatton Date: Fri, 13 Sep 2024 17:02:52 +0000 Subject: [PATCH 2/2] resolve feedback re: changes --- docs/build-for-developers/cli-usage.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/docs/build-for-developers/cli-usage.md b/docs/build-for-developers/cli-usage.md index dc599bc661e..33534b86367 100644 --- a/docs/build-for-developers/cli-usage.md +++ b/docs/build-for-developers/cli-usage.md @@ -4,7 +4,7 @@ sidebar_label: Basic usage slug: /cli-usage --- -This page shows examples for some of the most common usages of the CLI, such as: +This page shows examples for some of the most common usages of the CLI, including: - get help - run a job @@ -30,8 +30,7 @@ openfn deploy --help ### Run a job -To run a single job, you must explicitly specify which adaptor to use. -[Publicly available adaptors](/adaptors). See examples below. +To run a single job, you must explicitly specify which adaptor to use - see the [publicly available adaptors](/adaptors). Adaptors are automatically installed if the specified version is not detected. @@ -177,8 +176,8 @@ openfn repo clean ### Run a workflow -
- A workflow has a structure like this: +
+ Click to view an example workflow's JSON structure ```json {