Skip to content

Commit ac67db1

Browse files
committed
Modify titles to sentence case.
1 parent 9c9069e commit ac67db1

10 files changed

+44
-44
lines changed

fern/docs/pages/adaas/creating-a-keyring.mdx

Lines changed: 0 additions & 10 deletions
This file was deleted.

fern/docs/pages/adaas/extracting-attachments.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Attachment Extraction phase
1+
# Attachments extraction phase
22

33
For the Attachment Extraction phase of the import process,
44
the Extractor has to upload each attachment to DevRev’s S3 using the `S3Interact` API.

fern/docs/pages/adaas/extracting-data.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Data Extraction Phase
1+
# Data extraction phase
22

33
In the data extraction phase, the Extractor is expected to call the External System’s APIs
44
to retrieve all the items that were updated since the start of the last extraction.

fern/docs/pages/adaas/extracting-external-sync-units.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Extract External Sync Units Phase
1+
# Extract external sync units phase
22

33
In the External Sync Unit extraction phase, the Extractor is expected to get the list of projects, repositories, etc.
44
(whatever the equivalent of those is called in the External System)

fern/docs/pages/adaas/extracting-metadata.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Extract Metadata Phase
1+
# Extract metadata phase
22

33
During the `EXTRACT_METADATA` phase, the Worker must provide a JSON file named `initial_domain_mapping.json`,
44
and upload it as an Artifact with item type `initial_domain_mapping`.

fern/docs/pages/adaas/extraction-phases.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Extraction Phases
1+
# Extraction phases
22

33
Airdrop extractions are done in phases.
44
Phases follow sequentially, and each can consist of one or more invocations of the Worker.
@@ -79,7 +79,7 @@ A Deletion Sync consists of the following phases:
7979
- Delete data,
8080
- Delete attachments.
8181

82-
## External Sync Unit Extraction
82+
## External sync unit extraction
8383

8484
External Sync Unit Extraction is an extraction phase, executed only during the Initial Import.
8585
It extracts External Sync Units available in the External System,
@@ -91,7 +91,7 @@ Airdrop initiates the External Sync Unit Extraction phase by starting the Worker
9191
The Worker must respond to Airdrop with a message with eventType `EXTRACTION_EXTERNAL_SYNC_UNITS_DONE`
9292
with a list of External Sync Units as a payload, or `EXTRACTION_EXTERNAL_SYNC_UNITS_ERROR` in case of an error.
9393

94-
## Metadata Extraction
94+
## Metadata extraction
9595

9696
Airdrop initiates the Metadata Extraction by starting the Worker with a message with eventType: `EXTRACTION_METADATA_START`.
9797

@@ -102,7 +102,7 @@ to prepare and upload the Initial Domain Mapping to DevRev.
102102
The Worker must respond to Airdrop with a message with eventType `EXTRACTION_METADATA_DONE` when done,
103103
or `EXTRACTION_METADATA_ERROR` in case of an error.
104104

105-
## Data Extraction
105+
## Data extraction
106106

107107
Airdrop initiates Data Extraction by starting the Worker with a message with eventType `EXTRACTION_DATA_START`
108108
when transitioning to the Data Extraction phase.
@@ -124,7 +124,7 @@ Once the Data Extraction is done, the Worker must respond to Airdrop with a mess
124124

125125
If Data Extraction failed in any moment of extraction, the Worker must respond to Airdrop with a message with eventType `EXTRACTION_DATA_ERROR`.
126126

127-
## Attachments Extraction
127+
## Attachments extraction
128128

129129
Airdrop initiates the Attachment Extraction by starting the Worker with a message with eventType `EXTRACTION_ATTACHMENTS_START`
130130
when transitioning to the Data Extraction phase.
@@ -146,7 +146,7 @@ Once the Attachment Extraction phase is done, the Worker must respond to Airdrop
146146

147147
If Attachment Extraction failed, the Worker must respond to Airdrop with a message with eventType `EXTRACTION_ATTACHMENTS_ERROR`.
148148

149-
## Delete Data
149+
## Delete data
150150

151151
Airdrop initiates the Data Delete phase when the Sync is deleted from DevRev.
152152
It is started by sending the Worker a message with eventType: `EXTRACTION_DATA_DELETE`.
@@ -156,7 +156,7 @@ In the most common extraction use cases, there is nothing to do and Workers may
156156

157157
The Worker must respond to Airdrop with a message with eventType `EXTRACTION_DATA_DELETE_DONE` when done or `EXTRACTION_DATA_DELETE_ERROR` in case of an error.
158158

159-
## Delete Attachments
159+
## Delete attachments
160160

161161
Airdrop initiates the Attachments Delete phase when the Sync is deleted from DevRev.
162162
It is started by sending the Worker a message with eventType: `EXTRACTION_ATTACHMENTS_DELETE`.

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

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Getting Stated
1+
# Getting started
22

33
1. Create a new repo from the ADaaS Template repo:
44
On [https://github.com/devrev/adaas-template](https://github.com/devrev/adaas-template) use the dropdown button `Use this template` and
@@ -17,3 +17,25 @@ See [Creating a Keyring](https://www.notion.so/Creating-a-Keyring-aa497671dc1b42
1717
7. Install the Snap-In in your DevRev DevOrg on the web by navigating to `Settings` -> `Snap-ins` -> `Install Snap-in`.
1818
8. Define the `Connection`.
1919
9. Create an `Import.`
20+
21+
22+
## Creating keyrings
23+
24+
Keyrings are a DevRev-specific mechanism for managing authentication for External Systems.
25+
They are called Connections in the DevRev app.
26+
27+
They provide a secure way to store and manage credentials within your DevRev Snap-In.
28+
This eliminates the need to expose sensitive information like passwords
29+
or access tokens directly within your code or configuration files, enhancing overall security.
30+
31+
Read more about Keyrings in the [developer documentation](https://developer.devrev.ai/snapin-development/references/keyrings).
32+
33+
34+
## Observability
35+
36+
Workers are snap-ins, and they inherit observability methodology from snap-ins.
37+
38+
To observe logs from your Worker in your development environment use `devrev snap_in_package logs | jq`.
39+
To open logs in your favorite editor use `devrev snap_in_package logs | code -`
40+
41+
See also: https://developer.devrev.ai/snapin-development/debugging

fern/docs/pages/adaas/observability.mdx

Lines changed: 0 additions & 6 deletions
This file was deleted.

fern/docs/pages/adaas/terminology.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Terminology
22

3-
## External System
3+
## External system
44

55
An External System refers to any system (data source, CRM, etc.) that is not DevRev, e.g., Jira, Zendesk, HubSpot, etc.
66
The External System ID is the identifier of an organization in the External System.
@@ -14,7 +14,7 @@ It allows our customers to bring in their existing data from [External Systems](
1414
sync data back to External Systems, and keep data in sync between DevRev and the External Systems.
1515
You can read more about Airdrop in the [general documentation](https://docs.devrev.ai/import#airdrop-features).
1616

17-
## Snap-In
17+
## Snap-in
1818

1919
A Snap-In is a component that extends DevRev’s functionality.
2020
It provides a base platform for creating [ADaaS Workers](#worker) ([Extractors](#extractor) and [Loaders](#loader)).
@@ -40,22 +40,22 @@ It is very similar to an [Extractor](#extractor), but it does the reverse job.
4040

4141
An [Extractor](#extractor) or [Loader](#loader).
4242

43-
## Forward Sync
43+
## Forward sync
4444

4545
A Forward Sync is a sync from an [External System](#external-system) to DevRev.
4646
An [Extractor](#extractor) is used to extract the created and/or updated data from the [External System](#external-system).
4747

48-
## Reverse Sync
48+
## Reverse sync
4949

5050
A Reverse Sync is a sync from DevRev to an [External System](#external-system).
5151
A [Loader](#loader) is used to load the created and/or updated data to the [External System](#external-system).
5252

53-
## Initial Import
53+
## Initial import
5454

5555
An Initial Import is the first import of data from the [External System](#external-system) to DevRev.
5656
It is triggered manually by the end user in DevRev's Imports UI.
5757

58-
## 1-way Sync
58+
## 1-way sync
5959

6060
A 1-way Sync refers to an extraction, done after an [Initial Import](#initial-import) has been run.
6161
An [Extractor](#extractor) extracts data that was created and/or updated in the [External System](#external-system)
@@ -65,12 +65,12 @@ including any changes that occurred during the [Forward Sync](#forward-sync), bu
6565
An [Extractor](#extractor) must consult its state
6666
to get information on when the last successful [Forward Sync](#forward-sync) started.
6767

68-
## Sync Unit
68+
## Sync unit
6969

7070
A Sync Unit is the import/sync of a project, repository, etc., that is happening between DevRev and an [External System](#external-system).
7171
The Sync Unit ID is the unique identifier of the import/sync in DevRev.
7272

73-
## External Sync Unit
73+
## External sync unit
7474

7575
An External Sync Unit refers to a single unit in the [External System](#external-system) that we are airdropping to DevRev.
7676
In some systems, this is a project, in some it is a repository, in support systems this External Sync Unit could be called a brand or an organization.
@@ -83,7 +83,7 @@ while their enterprise plans may offer their clients to operate many separate un
8383
The External Sync Unit ID is the identifier of the project, repository, etc. in the [External System](#external-system).
8484
For GitHub, this would be the repository, i.e. `cli` in `github.com/devrev/cli`.
8585

86-
## Sync Run
86+
## Sync run
8787

8888
A Sync Run is one instance of an [Initial Import](#initial-import) any type of sync.
8989
If you do an import from Jira to DevRev, that import will be one Sync Run.
@@ -110,7 +110,7 @@ It constructs the Recipe based on the following inputs:
110110
- results of the schema discovery performed on raw data,
111111
- end-user inputs provided in the Mapping Screen during a [Sync Run](#sync-run).
112112

113-
## Initial Domain Mapping
113+
## Initial domain mapping
114114

115115
An Initial Domain Mapping is a JSON document that provides a list of possible mappings between the
116116
[External System](#external-system)'s domain model and the DevRev domain model.

fern/versions/public.yml

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -128,9 +128,6 @@ navigation:
128128
- page: "Extraction Phases"
129129
slug: extraction-phases
130130
path: ../docs/pages/adaas/extraction-phases.mdx
131-
- page: "Creating a Keyring"
132-
slug: keyring
133-
path: ../docs/pages/references/adaas/creating-a-keyring.mdx
134131
- page: "Extracting External Sync Units"
135132
slug: extract-external-sync-units
136133
path: ../docs/pages/adaas/extracting-external-sync-units.mdx
@@ -143,9 +140,6 @@ navigation:
143140
- page: "Extracting Attachments"
144141
slug: extract-attachments
145142
path: ../docs/pages/adaas/extracting-attachments.mdx
146-
- page: "Obsevability"
147-
slug: extract-attachments
148-
path: ../docs/pages/adaas/observability.mdx
149143
- section: References
150144
slug: references
151145
contents:

0 commit comments

Comments
 (0)