OpenFn / OpenFn/docs

Collections: make the adaptor structure a bit clearer

Open
#630 0 comments 0 reactions 1 assignee View on GitHub

@josephjclark is already working on this.

Since Jan 28, 2025.

Dominant language
JavaScript
Stars
23
Forks
20
Avg merge
3d 1h
Merged PRs (30d)
6

Description

In the main docs, in the big info boxout, we should make it clearer that you do not choose the Collections adaptor, the API is always there. Maybe recommend choosing common by default.

Image

In the Adaptor Overview docs, make it clear that the collections API can be used with any adaptor. Make it clear that you don't choose the Collections adaptor. Recommend choosing common.

Basically we need to tell a simpler story about how you use the collections API (its sort of an adaptor but not)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.