Skip to content
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
4 changes: 1 addition & 3 deletions .agents/skills/translate/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ need.
If you are not told which task, work out which ones are needed from what has
changed in English, say so, and ask before starting.

Never translate the generated adaptor pages, the job library, or articles and
blog posts.
Never translate the generated adaptor pages, or articles and blog posts.

## Before you start

Expand Down Expand Up @@ -73,7 +72,6 @@ These apply to both tasks.
Build the site and make sure it passes:

```bash
yarn generate-library
yarn generate-adaptors
yarn build
```
Expand Down
1 change: 0 additions & 1 deletion .agents/skills/update-content/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ the PR for the next run. Format the files you changed with
broken links:

```bash
yarn generate-library
yarn generate-adaptors
yarn build
```
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ jobs:
git config --global user.email "actions@gihub.com"
git config --global user.name "gh-actions"
yarn install
yarn generate-library
yarn generate-adaptors
yarn build
npx docusaurus deploy
1 change: 0 additions & 1 deletion .github/workflows/test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,5 @@ jobs:
run: yarn install
- name: Test build website
run: |
yarn generate-library
yarn generate-adaptors
yarn build
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@

# these directories are built automatically and overwritten
/adaptors/packages/
/adaptors/library/jobs/auto/

# Generated files
.docusaurus
Expand Down
7 changes: 3 additions & 4 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ you need.

**Do not edit**

- Anything in `adaptors/packages/` or `adaptors/library/`. These pages are built
automatically from code comments in the `OpenFn/adaptors` repo. If something
is wrong there, the fix belongs in that repo, not here.
- Anything in `adaptors/packages/`. These pages are built automatically from
code comments in the `OpenFn/adaptors` repo. If something is wrong there, the
fix belongs in that repo, not here.

**Ask before editing**

Expand Down Expand Up @@ -92,7 +92,6 @@ change only, so it stays quick to review.
Before opening any PR, build the site as CI does. It fails on broken links:

```bash
yarn generate-library
yarn generate-adaptors
yarn build
```
Expand Down
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,17 +71,8 @@ yarn start --locale es
```

The development server shows one language at a time. This serves the Spanish
site at the root, with English wherever a page isn't translated yet. To see
both languages together at `/` and `/es/`, build and serve the site as below.

### Building the job library

```
yarn generate-library
```

This command pulls public job data from OpenFn.org to create a local "job
library".
site at the root, with English wherever a page isn't translated yet. To see both
languages together at `/` and `/es/`, build and serve the site as below.

### Building the adaptors docs from the monorepo

Expand Down Expand Up @@ -117,7 +108,6 @@ for more details

```console
yarn generate-adaptors
yarn generate-library
yarn build
yarn serve
```
Expand Down
13 changes: 6 additions & 7 deletions adaptors/asana.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,11 @@ JSON credential type, then your configuration will look something like this:
Asana sync:
[https://openfn.github.io/ConSoSci/asana/](https://openfn.github.io/ConSoSci/asana/)

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/azure-storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,11 @@ JSON credential type, then your configuration will look something like this:

_Coming soon!_

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/beyonic.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,11 @@ JSON credential type, then your configuration will look something like this:

_Coming soon!_

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/bigquery.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,11 @@ JSON credential type, then your configuration will look something like this:

_Coming soon!_

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/cartodb.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,11 @@ section.
- [CARTO API Reference](https://api-docs.carto.com/)
- [OpenFn CartoDB Adaptor](https://docs.openfn.org/adaptors/packages/cartodb-readme)

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/chatgpt.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,11 @@ technical docs on the authentication parameters required.
- API docs: https://platform.openai.com/docs/overview
- API Intro: https://www.chatbase.co/blog/chatgpt-api

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/cht.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,12 +100,11 @@ this:
- CHT Docs: https://docs.communityhealthtoolkit.org/
- CHT Community: https://forum.communityhealthtoolkit.org/

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/ckan.md
Original file line number Diff line number Diff line change
Expand Up @@ -222,12 +222,11 @@ CKAN has been implemented in [catalog.data.gov](https://catalog.data.gov),
[open.canada.ca/data](https://open.canada.ca/data), and
[data.humdata.org](https://data.humdata.org).

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/claude.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,12 +61,11 @@ technical docs on the authentication parameters required.
- About Claude: https://claude.ai/
- API docs: https://www.anthropic.com/api

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
9 changes: 9 additions & 0 deletions adaptors/collections.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,3 +400,12 @@ more information on how you can update Adaptors!

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).

:::info Report or fix a problem with this adaptor

OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

:::
40 changes: 33 additions & 7 deletions adaptors/commcare.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,33 @@ learn more about the data export tool, see the

:::

## Examples

### Create a user and submit a case

This job creates a mobile worker, then uploads a case for them with `submitXls`.

```js
// Create a user and submit their case to commcare

post('user', {
username: 'janedoe42',
password: 'change-me-on-first-login',
first_name: 'Jane',
last_name: 'Doe',
default_phone_number: '+50253311399',
email: 'jdoe@example.org',
});

submitXls([{ name: $.data.username, feeling_sick: 'No' }], {
case_type: 'pregnancy',
search_field: 'case_id',
search_column: 'case_id',
name_column: 'name',
create_new_cases: 'on',
});
```

## Authentication

[See CommCare docs](https://dimagi.atlassian.net/wiki/spaces/commcarepublic/pages/2143946031/Authentication)
Expand Down Expand Up @@ -396,12 +423,11 @@ CommCare has different APIs for reading vs. modifying data. Some helpful links:
- Lwala (CommCare-Salesforce 2-way sync): https://github.com/OpenFn/lwala
- myAgro (CommCare-Salesforce): https://github.com/OpenFn/myagro-commcare-sf

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/common.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,11 @@ each(
);
```

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
13 changes: 6 additions & 7 deletions adaptors/dagu.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,11 @@ configuration will look something like this:
}
```

### I've noticed a problem with this Adaptor, or something is out of date, what can I do?
:::info Report or fix a problem with this adaptor

Thanks for asking! We are a fully Open Source Digital Public Good, and we
welcome contributions from our community. Check out our
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) for
more information on how you can update Adaptors!
OpenFn adaptors are open source and we welcome contributions. See the
[Adaptors Wiki](https://github.com/OpenFn/adaptors/blob/main/wiki/index.md) to
learn how to update an adaptor, or ask on the
[OpenFn Community Forum](https://community.openfn.org/).

Or, you can always reach out to the Community through our
[Community Forum here](https://community.openfn.org/).
:::
Loading
Loading