Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minor changes to collections docs #612

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Minor changes to collections docs #612

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3a8457
Fixed typos and readaility
christad92 Dec 5, 2024
64bdd10
More copy updates
christad92 Dec 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions adaptors/collections.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,18 @@ 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).

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).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey, in formal technical documentation, I don't think it's appropriate to use here as link text. What is here? Where does the link go? It's needlessly mysterious: better to clearly signpost what we're linking to.

It's usually better to use the page title (even if it might drift out of date over time). But since this page is also called Collections it's probably better to maybe say Collections Documentation or even Main Collections Documentation

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

uhmm.. will review and push again. Thanks


:::caution

Expand All @@ -31,9 +31,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.
Expand Down
Loading