Skip to content

Commit b28ac36

Browse files
Minor Airdrop fixes (#253)
1 parent ea40bbb commit b28ac36

File tree

3 files changed

+9
-9
lines changed

3 files changed

+9
-9
lines changed

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@ as well as the capabilities and limitations of the external system being integra
33

44
## DevRev organization
55

6-
If this is your first time setting up an organization within DevRev, you need to create a
7-
DevRev organization for developing your new Airdrop snap-in:
6+
If this is your first time developing a snap-in, you should start by creating a new DevRev organization:
87

98
1. Click on your profile picture in the top left corner.
109
2. Go to the **Orgs** section and click on **+**.
@@ -40,13 +39,13 @@ A _sync unit_ is one self-encompassing unit of data that is synced to an externa
4039
- An organization Zendesk.
4140

4241
In Jira, users often have multiple projects. Each project acts as an individual sync unit.
43-
In contrast, Zendesk operates with a single large pool of tickets and agents. Here, the entire Zendesk instance can be synced in a single airdrop.
42+
In contrast, Zendesk operates with a single large pool of tickets and agents. Here, the entire Zendesk instance can be synced in a single import.
4443

4544
### Sync run
4645

4746
Airdrop extractions are done in _sync runs_.
4847
A sync run is one end-to-end (extract-transform-load) execution of a _sync unit_.
49-
If you do an initial import from the external system to DevRev, that import will be one sync run.
48+
If you do an initial import from the external system to DevRev, that import is one sync run.
5049
Another import in the same direction is another sync run.
5150
And if you then decide to do a reverse sync from DevRev to the external system, that would be another
5251
sync run.

fern/docs/pages/airdrop/local-development.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ For easier development you can run your Airdrop snap-in locally and receive logs
33
## Prerequisites
44

55
- [devrev-cli](https://developer.devrev.ai/snapin-development/references/cli-install) (version 4.7 or higher)
6+
- [chef-cli](https://github.com/devrev/adaas-chef-cli)
67
- [jq](https://stedolan.github.io/jq)
78
- [nodejs](https://nodejs.org/en/download/package-manager) (version 18.x.x+ or higher)
89
- [ngrok](https://ngrok.com)
@@ -13,7 +14,7 @@ DevRev offers a starter Airdrop snap-in template that is ready for immediate use
1314

1415
1. Create a new repository:
1516
- Create a new repository from this template by clicking the "Use this template" button in the upper right corner and then "Create a new repository".
16-
- The repository name must start with `airdrop-` (for example, `airdrop-<external system>-snap-in`).
17+
- The repository name must start with `airdrop-` (for example, `airdrop-asana-snap-in`).
1718
2. Open the project in your IDE and authenticate to your DevRev organization using the DevRev CLI:
1819
```bash
1920
devrev profiles authenticate --org <your DevRev organization slug>
@@ -48,10 +49,10 @@ DevRev offers a starter Airdrop snap-in template that is ready for immediate use
4849

4950
# Initial sync
5051

51-
Now that you have a running snap-in, you can start an airdrop.
52+
Now that you have a running snap-in, you can start an import.
5253
Go to DevRev app and click **Airdrops** -> **Start Airdrop** -> **Your snap-in**.
5354

54-
1. Starting an airdrop begins with establishing a connection to the external system. The Airdrop snap-in prompts for specific information needed to create this connection. Afterwards, the snap-in verifies that the connection is successful and you should see a success message.
55+
1. Starting an import begins with establishing a connection to the external system. The Airdrop snap-in prompts for specific information needed to create this connection. Afterwards, the snap-in verifies that the connection is successful and you should see a success message.
5556

5657
2. Once the connection is established, the snap-in collects information from the external system about the data unit to be exported. This phase is called _external sync units extraction_. An external sync unit is the data unit from the external system to be imported to DevRev. At this point, the DevRev app prompts the user to select an external sync unit from the list.
5758

@@ -65,4 +66,4 @@ Go to DevRev app and click **Airdrops** -> **Start Airdrop** -> **Your snap-in**
6566

6667
The process described above is called the **initial sync**. In all subsequent syncs, the first two steps are skipped.
6768

68-
The snap-in constantly communicates with Airdrop platform, which manages its behavior. When an action occurs in the DevRev app, Airdrop platform sends a message to the snap-in with details about the event. The snap-in performs an action based on the event type. For example, when a user starts a new airdrop for the first time, Airdrop platform instructs the snap-in to perform an external sync unit extraction. The snap-in carries out the task and sends back available sync units to Airdrop platform.
69+
The snap-in constantly communicates with Airdrop platform, which manages its behavior. When an action occurs in the DevRev app, Airdrop platform sends a message to the snap-in with details about the event. The snap-in performs an action based on the event type. For example, when a user starts a new import for the first time, Airdrop platform instructs the snap-in to perform an external sync unit extraction. The snap-in carries out the task and sends back available sync units to Airdrop platform.

fern/docs/pages/airdrop/manifest.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ keyring_types:
110110
There are some options to consider:
111111

112112
* `kind`
113-
The `kind` option can be either "secret" or "oauth2". The "secret" option is intended for storing various tokens, such as a PAT token. Use of OAuth2 is encouraged when possible. More information is available for [secret](/public/snapin-development/references/keyrings/secret-configuration) and [oauth2](/oauth-configuration).
113+
The `kind` option can be either "secret" or "oauth2". The "secret" option is intended for storing various tokens, such as a PAT token. Use of OAuth2 is encouraged when possible. More information is available for [secret](/public/snapin-development/references/keyrings/secret-configuration) and [oauth2](/public/snapin-development/references/keyrings/oauth-configuration).
114114

115115
* `is_subdomain`
116116
The `is_subdomain` field relates to the API endpoints being called. When the endpoints for fetching data from an external system include a slug representing the organization—such as for example `https://subdomain.freshdesk.com/api/v2/tickets`—set this key to "true". In this scenario, users creating a new connection are prompted to insert the subdomain.

0 commit comments

Comments
 (0)