Skip to content

Commit 8cafb30

Browse files
Merge pull request #674 from OpenFn/v3
V3
2 parents 72fe3ec + 633cd60 commit 8cafb30

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+4578
-4194
lines changed

adaptors/collections.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Learn more about Collections and common use cases in the
2424
:::caution
2525

2626
Collections must be created in the
27-
[Platform Admin page](https://docs.openfn.org/documentation/build/collections#managing-collections)
27+
[Platform Admin page](/documentation/build/collections#managing-collections)
2828
before they can be used.
2929

3030
:::
@@ -60,17 +60,17 @@ fetch all keys which relate to Mr Benn in 2024).
6060
The Collections API gives you four functions to read, write and remove data from
6161
a collection.
6262

63-
- Use [`collections.get()`](adaptors/packages/collections-docs#collections_get)
63+
- Use [`collections.get()`](/adaptors/packages/collections-docs#collections_get)
6464
to fetch a single value, or batch-download a range of values.
6565
- Use
66-
[`collections.each()`](adaptors/packages/collections-docs#collections_each) to
66+
[`collections.each()`](/adaptors/packages/collections-docs#collections_each) to
6767
efficiently iterate over a range of items in a collection. Recommended for
6868
large data sets.
69-
- Use [`collections.set()`](adaptors/packages/collections-docs#collections_set)
69+
- Use [`collections.set()`](/adaptors/packages/collections-docs#collections_set)
7070
to upload one or more values to a collection. `set()` is always an "upsert":
7171
if a key already exists, it's value will be replaced by the new value
7272
- Use
73-
[`collections.remove()`](adaptors/packages/collections-docs#collections_remove)
73+
[`collections.remove()`](/adaptors/packages/collections-docs#collections_remove)
7474
to remove one or more values.
7575

7676
Detailed usage examples are provided below.
@@ -184,7 +184,7 @@ collections.get('my-collection', 'commcare-fhir-value-mappings').then(state => {
184184
state.mappings = state.data;
185185
return state;
186186
});
187-
collecions.each($.inputs, state => {
187+
collections.each($.inputs, state => {
188188
const mappedString = state.mappings[state.data.diagnosis];
189189
state.resources ??= {};
190190
state.resources[state.data.id] = mappedString;
@@ -238,7 +238,7 @@ collections.each(
238238
239239
You can use `createdBefore` and `createdAfter` dates, which must be ISO 1806
240240
formatted strings. The `createdBefore` timestamp will match all dates less than
241-
or equal to (<=) the _start_ of the provided date. Conversely, `createdAfter`
241+
or equal to (&lt;=) the _start_ of the provided date. Conversely, `createdAfter`
242242
will match dates greater than or equal to the _end_ of the provided date.
243243
244244
By default, all matching values will be returned to you, but you can limit how

adaptors/dynamics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ title: Dynamics Adaptor
1616

1717
See [Microsoft docs](https://learn.microsoft.com/en-us/azure/active-directory/) for the latest on supported authentication methods. When integrating with Dynamics via OpenFn, **Access Token** is supported. See this adaptor's [Configuration docs](/adaptors/packages/dynamics-configuration-schema) for more on the required authentication parameters.
1818

19-
See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
19+
See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
2020

2121
```
2222
{

adaptors/googlehealthcare.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The [Google Cloud Healthcare API](https://cloud.google.com/healthcare-api) is a
1717
1. See [Google Cloud Healthcare API docs](https://cloud.google.com/healthcare-api/docs/authentication#:~:text=You%20can%20authenticate%20to%20the,CLI%20credentials%20and%20ADC%20credentials.) for the latest on supported authentication methods.
1818
2. When integrating with Google Cloud Healthcare via OpenFn, there is one primary authentication method that is supported: **Access Token**. See this adaptor's [Configuration docs](/adaptors/packages/googlehealthcare-configuration-schema) for more on the required authentication parameters.
1919

20-
See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
20+
See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
2121

2222
```
2323
{

adaptors/hubtel.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Hubtel supports two primary integration options with OpenFn:
1919
2. When integrating with Hubtel via OpenFn, authentication via **API Key** is supported.
2020
3. See this adaptor's [Configuration docs](/adaptors/packages/hubtel-configuration-schema) for more on the required authentication parameters.
2121

22-
See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
22+
See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
2323

2424
```
2525
{

adaptors/mailchimp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Mailchimp supports two primary integration options:
1818

1919
When integrating with Mailchimp via OpenFn, authentication via **API Key** is supported ([see MC docs](https://mailchimp.com/developer/marketing/docs/fundamentals/#connecting-to-the-api). See this adaptor's [Configuration docs](/adaptors/packages/mailchimp-configuration-schema) for more on the required authentication parameters.
2020

21-
See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
21+
See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
2222

2323
```
2424
{

adaptors/ocl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This option is suited for scheduled synchronization or workflows requiring regul
1818
## Authentication
1919
When integrating with OCL via OpenFn, you must provide a username and password to generate an authorization token ([see OCL docs](https://docs.openconceptlab.org/en/latest/oclapi/overview.html#authentication-and-authorization)). See this adaptor's [Configuration docs](/adaptors/packages/ocl-configuration-schema) for more on the required authentication parameters.
2020

21-
See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
21+
See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
2222

2323
```
2424
{

adaptors/odoo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Odoo supports two primary integration options with OpenFn:
2121
2. When integrating with Odoo via OpenFn, authentication via **User Credentials** is supported.
2222
3. See this adaptor's [Configuration docs](/adaptors/packages/odoo-configuration-schema) for more on the required authentication parameters.
2323

24-
See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
24+
See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
2525

2626
```
2727
{

adaptors/openmrs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When integrating with OpenMRS via OpenFn, **Basic Authentication** is supported.
2929
The `instanceUrl`, `username` an `password` properties are all required to
3030
access your OpenMRS instance.
3131

32-
See [Managing Credentials](documentation/manage-projects/manage-credentials) to
32+
See [Managing Credentials](/documentation/manage-projects/manage-credentials) to
3333
configure a credential in OpenFn.
3434

3535
If working locally or if using a Raw JSON credential type, then your

adaptors/sftp.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Using this adaptor, you can read and write files (e.g., `csv`, `xls`, `json` fil
1616

1717
When integrating with a SFTP server via OpenFn, you can provide a `username` and `password` for an authorized user to authenticate. See this adaptor's [Configuration docs](/adaptors/packages/sftp-configuration-schema) for more on the required authentication parameters.
1818

19-
See platform docs on [managing credentials](documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
19+
See platform docs on [managing credentials](/documentation/manage-projects/manage-credentials) for how to configure a credential in OpenFn. If working locally or if using a Raw JSON credential type, then your configuration will look something like this:
2020

2121
```
2222
{

articles/2020-06-16-how-information-is-organized.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
---
22
layout: post
33
title: 'How Information Is Organized... In Organizations'
4-
author: Taylor Downs
5-
author_url: https://github.com/taylordowns2000
6-
author_image_url: https://avatars.githubusercontent.com/taylordowns2000
4+
authors: taylor
75
tags: [how-to, tips]
86
image: /img/informationorganized.jpg
97
featured: false
@@ -61,7 +59,7 @@ technology.
6159

6260
### Boxes and crow's feet
6361

64-
![]({{ site.baseurl }}/assets/images/box5.png)
62+
![](/img/box5.png)
6563

6664
The box is my favorite. It represents an entity in your data system. Entities
6765
(like `teachers`) have attributes (like `name`, `phone number`, `date of birth`,
@@ -71,7 +69,7 @@ gender, etc. These are the fields on your teacher entity. By submitting one of
7169
these forms, you’ll add a new teacher to your database. If you’re an Excel
7270
person, the attributes are columns in your `teachers` table.
7371

74-
![]({{ site.baseurl }}/assets/images/crowsfeet2.png)
72+
![](/img/crowsfeet2.png)
7573

7674
The crow’s foot is my second favorite. It’s used to show relationships between
7775
entities. We know that teachers are related to the sessions that they conduct.
@@ -85,7 +83,7 @@ relationship. The crow’s foot (that little three-pronged fella) denotes the
8583
many. One teacher can have many sessions. One session, however, can only have
8684
one teacher. See the diagram below.
8785

88-
![]({{ site.baseurl }}/assets/images/objectmodel3.png)
86+
![](/img/objectmodel3.png)
8987

9088
If we focus just on `teacher` and `session` and think back to MS Excel, we can
9189
envision a `teachers` table and a `sessions` table. Let’s put them on different
@@ -131,4 +129,5 @@ interchangeable parts. Alas, the middle way is probably the best.
131129
That’s all for now. More soon.
132130

133131
_Need help organizing or scaling your organization's information or process
134-
flows? Contact our team of ICT4D specialists at <[email protected]>._
132+
flows? Contact our team of ICT4D specialists at
133+

0 commit comments

Comments
 (0)