From f3a845767760102a1b59a2ccf8a764775efe17bb Mon Sep 17 00:00:00 2001 From: christad92 Date: Thu, 5 Dec 2024 06:55:36 +0000 Subject: [PATCH 1/3] Fixed typos and readaility --- adaptors/collections.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/adaptors/collections.md b/adaptors/collections.md index 2ef3de8b745..ca261803f1b 100644 --- a/adaptors/collections.md +++ b/adaptors/collections.md @@ -4,12 +4,13 @@ title: Collections Adaptor ## Collections Overview -The Collections API provides access to a secure key/value store on the OpenFn -Platform. It is designed for high performance over a large volume of data. +The Collections API provides access to a secure key/value store that allows +users to store, update and reuse data across workflows in their OpenFn projects. +It is designed for high performance over a large volume of data. -Collections are secure, private datastores which are visible only to Workflows -within a particular OpenFn Project. They can be created, managed and destroyed -from the OpenFn Admin page. +Collections are secure, private datastores which are only accessible to +Workflows within a particular OpenFn Project. They can be created, managed and +destroyed from the OpenFn Admin page. When running in the CLI, a Personal Access Token can be used to get access to the collection (generated from the app at /profile/tokens). @@ -31,9 +32,9 @@ The Collections API is inserted into all Steps through a special kind of adaptor. Uniquely, the Collections adaptor it is designed to be run _alongside_ other -adaptors, not by itself. It is injected into the runtime environment for you for -you by OpenFn. This makes the Collections API available to every Step in a -Workflow, regardless of which adaptor it is using. +adaptors, not by itself. It is automatically injected into the runtime +environment making the Collections API available to every Step in a Workflow, +regardless of which adaptor it is using. If using the CLI run a workflow with Collections, refer to the [CLI Usage](#cli-usage) guide below. From 64bdd107331bd91c8e345eb1220d0a6618c86dee Mon Sep 17 00:00:00 2001 From: christad92 Date: Thu, 5 Dec 2024 06:59:38 +0000 Subject: [PATCH 2/3] More copy updates --- adaptors/collections.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/adaptors/collections.md b/adaptors/collections.md index ca261803f1b..130e0aca04e 100644 --- a/adaptors/collections.md +++ b/adaptors/collections.md @@ -15,8 +15,7 @@ destroyed from the OpenFn Admin page. When running in the CLI, a Personal Access Token can be used to get access to the collection (generated from the app at /profile/tokens). -See the [Collections](/documentation/build/collections) Platform Docs to learn -more about Collections. +Learn more about collections and common use cases [here](/documentation/build/collections). :::caution From 14c62b75c764b9cc06a2f789428b95b24be831b3 Mon Sep 17 00:00:00 2001 From: Joe Clark Date: Tue, 24 Dec 2024 09:30:45 +0000 Subject: [PATCH 3/3] minor adjustments --- adaptors/collections.md | 18 +++++++++++------- 1 file changed, 11 insertions(+), 7 deletions(-) diff --git a/adaptors/collections.md b/adaptors/collections.md index 130e0aca04e..1eef104e70c 100644 --- a/adaptors/collections.md +++ b/adaptors/collections.md @@ -12,30 +12,34 @@ Collections are secure, private datastores which are only accessible to Workflows within a particular OpenFn Project. They can be created, managed and destroyed from the OpenFn Admin page. +The Collections Adaptor provides an interface to workflows to use the +Collections API. + When running in the CLI, a Personal Access Token can be used to get access to the collection (generated from the app at /profile/tokens). -Learn more about collections and common use cases [here](/documentation/build/collections). +Learn more about Collections and common use cases in the +[Collections Docs](/documentation/build/collections). :::caution -Collections must be created in the platform Admin page before they can be used. - -Refer to the [Collections Docs](/documentation/build/collections) for details +Collections must be created in the +[Platform Admin page](https://docs.openfn.org/documentation/build/collections#managing-collections) +before they can be used. ::: ## The Collections Adaptor -The Collections API is inserted into all Steps through a special kind of -adaptor. +The Collections API is inserted into all each Step of a Workflow through a +special kind of adaptor. Uniquely, the Collections adaptor it is designed to be run _alongside_ other adaptors, not by itself. It is automatically injected into the runtime environment making the Collections API available to every Step in a Workflow, regardless of which adaptor it is using. -If using the CLI run a workflow with Collections, refer to the +If using the CLI the use Collections locally, refer to the [CLI Usage](#cli-usage) guide below. ## Usage Guide