From f3a845767760102a1b59a2ccf8a764775efe17bb Mon Sep 17 00:00:00 2001 From: christad92 Date: Thu, 5 Dec 2024 06:55:36 +0000 Subject: [PATCH 1/2] 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/2] 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