Skip to content

Commit a53672b

Browse files
fix: Minor Airdrop fixes (#200)
* Minor Airdrop fixes * Fix links to airdrop template
1 parent 969736c commit a53672b

9 files changed

+15
-15
lines changed

fern/docs/pages/airdrop/attachments-extraction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ type `EXTRACTION_ATTACHMENTS_ERROR`.
3131
## Implementation
3232

3333
Attachments extraction is already provided by SDK, but if you need to customize it for your use case,
34-
it should be implemented in the [attachments-extraction.ts](https://github.com/devrev/adaas-template/blob/main/code/src/functions/extraction/workers/attachments-extraction.ts) file.
34+
it should be implemented in the [attachments-extraction.ts](https://github.com/devrev/airdrop-template/blob/main/code/src/functions/extraction/workers/attachments-extraction.ts) file.
3535

3636
After uploading an attachment or a batch of attachments, the extractor also has to prepare and
3737
upload a file specifying the extracted and uploaded attachments.

fern/docs/pages/airdrop/data-extraction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ message with event of type `EXTRACTION_DATA_ERROR`.
3434

3535
## Implementation
3636

37-
Data extraction should be implemented in the [data-extraction.ts](https://github.com/devrev/adaas-template/blob/main/code/src/functions/extraction/workers/data-extraction.ts) file.
37+
Data extraction should be implemented in the [data-extraction.ts](https://github.com/devrev/airdrop-template/blob/main/code/src/functions/extraction/workers/data-extraction.ts) file.
3838

3939
During the data extraction phase, the snap-in uploads batches of extracted items (with tooling from `@devrev/adaas-sdk`).
4040

@@ -103,7 +103,7 @@ A snap-in must consult its state to obtain information on when the last successf
103103

104104
Effective use of the state and breaking down the problem into smaller chunks are crucial for good performance and user experience. Without knowing what has been processed, the snap-in extracts the same data multiple times, using valuable API capacity and time, and possibly duplicates the data inside DevRev or the external application.
105105

106-
The snap-in starter template contains an [example](https://github.com/devrev/adaas-template/blob/main/code/src/functions/extraction/index.ts) of a simple state. Adding more data to the state can help with pagination and rate limiting by saving the point at which extraction was left off.
106+
The snap-in starter template contains an [example](https://github.com/devrev/airdrop-template/blob/main/code/src/functions/extraction/index.ts) of a simple state. Adding more data to the state can help with pagination and rate limiting by saving the point at which extraction was left off.
107107

108108
To test the state in development, you can decrease the timeout between snap-in invocations.
109109

fern/docs/pages/airdrop/external-sync-units-extraction.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ External sync unit extraction is executed only during the initial import.
1111

1212
### Implementation
1313

14-
This phase should be implemented in the [`external-sync-units-extraction.ts`](https://github.com/devrev/adaas-template/blob/main/code/src/functions/extraction/workers/external-sync-units-extraction.ts) file.
14+
This phase should be implemented in the [`external-sync-units-extraction.ts`](https://github.com/devrev/airdrop-template/blob/main/code/src/functions/extraction/workers/external-sync-units-extraction.ts) file.
1515

1616
The snap-in should emit the list of external sync units in the given format:
1717

fern/docs/pages/airdrop/getting-started.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ consider gathering the following information:
3535
### Sync unit
3636

3737
A _sync unit_ is one self encompassing unit of data that is synced to an external system. Examples:
38-
- Jira project
39-
- SalesForce
40-
- Zendesk
38+
- A project in Jira.
39+
- An account in SalesForce.
40+
- An organization Zendesk.
4141

4242
### Sync run
4343

fern/docs/pages/airdrop/manifest.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ They are called **Connections** in the DevRev app.
5757

5858
### Configure a keyring
5959

60-
Keyrings are configured in the `manifest.yaml` by configuring a `keyring_type`, like in the [example](https://github.com/devrev/adaas-template/blob/main/manifest.yaml).
60+
Keyrings are configured in the `manifest.yaml` by configuring a `keyring_type`, like in the [example](https://github.com/devrev/airdrop-template/blob/main/manifest.yaml).
6161

6262
```yaml
6363
keyring_types:

fern/docs/pages/airdrop/metadata-extraction.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ During the metadata extraction phase, the snap-in must provide an
33
This file provides a structured way of describing the external system's domain model,
44
including its domain entities, types, relationships, and other metadata.
55

6-
You can check which object types for Airdrop DevRev supports [here](/snapin-development/airdrop/supported-object-types).
6+
You can check which object types for Airdrop DevRev supports [here](/public/snapin-development/adaas/supported-object-types).
77

88
## Triggering event
99

@@ -15,7 +15,7 @@ when done, or `EXTRACTION_METADATA_ERROR` in case of an error.
1515

1616
## Implementation
1717

18-
Metadata extraction should be implemented in the [metadata-extraction.ts](https://github.com/devrev/adaas-template/blob/main/code/src/functions/extraction/workers/metadata-extraction.ts) file.
18+
Metadata extraction should be implemented in the [metadata-extraction.ts](https://github.com/devrev/airdrop-template/blob/main/code/src/functions/extraction/workers/metadata-extraction.ts) file.
1919

2020
```typescript
2121
import { ExtractorEventType, processTask } from "@devrev/ts-adaas";

fern/docs/pages/airdrop/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@ DevRev provides a range of snap-ins available through the DevRev marketplace for
66
various external systems like Jira and Zendesk. Sometimes, a specific snap-in may not be available
77
for a given external system. This is why DevRev enables creation of external connectors (extractors
88
and loaders) to other developers, allowing them to integrate with DevRev’s Airdrop and develop their
9-
Airdrop own snap-ins.
9+
own Airdrop snap-ins.
1010

1111
You can learn more about Airdrop in the [general documentation](https://docs.devrev.ai/import#airdrop-features).
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
You can find snap-in examples for various external systems [here](https://github.com/devrev/adaas-connector-examples).
1+
You can find snap-in examples for various external systems [here](https://github.com/devrev/airdrop-examples).
22

3-
Examples include:
3+
Examples currently include:
44

55
- Asana

fern/docs/pages/airdrop/snap-in-template.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Airdrop snap-in starter template is available [here](https://github.com/devrev/adaas-template).
1+
Airdrop snap-in starter template is available [here](https://github.com/devrev/airdrop-template).
22

33
The template makes use of **[DevRev's SDK library](https://www.npmjs.com/package/@devrev/ts-adaas)**,
44
which helps developers build snap-ins that integrate with DevRev’s Airdrop platform.
@@ -18,7 +18,7 @@ It provides features such as:
1818

1919
If you check the template, you can see that a snap-in is a Node.js project with a specific file structure:
2020

21-
```
21+
```yaml
2222
- manifest.yaml
2323
- code/
2424
- scripts/

0 commit comments

Comments
 (0)