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.

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

quick explanation and diagram of workflows v adaptors #560

Merged
merged 1 commit into from
Aug 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 17 additions & 7 deletions adaptors/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,18 @@ preferred way of communicating about adaptors is as follows:

In short, _most_ adaptors follow the naming convention `@openfn/language-xyz`.

## Where to find them
## Adaptors vs. Workflows

Adaptors are reusable components that make connecting with a specific app
easier, whereas [Workflows](/documentation/get-started/terminology#workflow) are
the project-specific processes that you want to automate. OpenFn users will
always leverage Adaptors to better understand how to work with specific APIs, to
access Adaptor helper functions (or "shortcuts") to more quickly build
Workflows, and to handle authenticatio. See the below diagram.

![workflows-adaptors-compare](/img/workflows-v-adaptors.png)

## Where to find Adaptors

<div>
Here's a list of the {generateList().length} publicly supported OpenFn
Expand Down Expand Up @@ -116,9 +127,9 @@ In short, _most_ adaptors follow the naming convention `@openfn/language-xyz`.

### On OpenFn

When creating or editing a job step, you can choose the adaptor to run
the job. This way you "import" the needed operations. Simply open the dropdown
list of adaptors, and click on one.
When creating or editing a job step, you can choose the adaptor to run the job.
This way you "import" the needed operations. Simply open the dropdown list of
adaptors, and click on one.

<img src="/img/adaptor-picker.webp" />

Expand Down Expand Up @@ -156,6 +167,5 @@ The source code and technical documentation for developing or extending existing
adaptors can be found
[here](https://github.com/OpenFn/adaptors#working-with-adaptors).

:::tip Need Help ?
See the [Get Help](/documentation/get-help/support) page for more information
:::
:::tip Need Help ? See the [Get Help](/documentation/get-help/support) page for
more information :::
Binary file added static/img/workflows-v-adaptors.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.