Skip to content

Commit f1dc689

Browse files
authored
Updates to ADaaS Documentation (chef-cli v0.5.0, getting started with ADaaS). (#128)
1 parent 78c7e3a commit f1dc689

File tree

2 files changed

+7
-8
lines changed

2 files changed

+7
-8
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Before you begin
22

33
- If you have not created a development organization on DevRev before, create a dedicated
4-
[DevOrg for development purposes](https://app.devrev.ai/) where you will be publishing your ADaaS snap-in.
4+
[DevRev organization for development purposes](https://app.devrev.ai/) where you will be publishing your ADaaS snap-in.
55
- Install required tools and packages:
66
- [devrev-cli](https://developer.devrev.ai/snapin-development/references/cli-install) (version 4.7 or higher)
77
- [jq](https://stedolan.github.io/jq)
@@ -12,9 +12,9 @@
1212

1313
1. Create a new repo from the [ADaaS template repo](https://github.com/devrev/adaas-template). Select _Use this template_ and
1414
then _Create a new repository_.
15-
1. Copy `Makefile.variable.example` to `Makefile.variable` and fill in the required variables.
15+
1. Copy `.env.example` to `.env` and fill in the required variables.
1616
1. Configure a keyring for the external system in the `manifest.yaml`.
17-
Refer to [Keyrings](/snapin-development/references/keyrings) for instructions.
17+
Refer to [Keyrings](/snapin-development/references/manifest#developer-keyrings) for instructions.
1818
1. Deploy a draft version of your snap-in to your dev org using `make deploy`.
1919
1. Install the snap-in in your DevRev at **Settings** > **Snap-ins** > **Install snap-in**.
2020
1. Define the connection at **Settings** > **Imports** > **Connections**.

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

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ mandatory fields or custom fields).
9797
Categories also provide a way how custom record types can be mapped.
9898

9999
If the external system allows records to change the record type within the category, while still preserving identity,
100-
this can be defined by the `are_transitions_possible` field in the `record_type_categories` section. For example, if
100+
this can be defined by the `are_record_type_conversions_possible` field in the `record_type_categories` section. For example, if
101101
an issue that can be moved to become a problem in the external system.
102102

103103
```json
@@ -121,7 +121,7 @@ mandatory fields or custom fields).
121121
},
122122
"record_type_categories":{
123123
"issue":{
124-
"are_transitions_possible":true
124+
"are_record_type_conversions_possible":true
125125
}
126126
}
127127
}
@@ -197,8 +197,7 @@ mandatory fields or custom fields).
197197
"key": "P-1"
198198
},
199199
{
200-
"key": "P-2",
201-
"is_deprecated": true
200+
"key": "P-2"
202201
}
203202
]
204203
}
@@ -239,7 +238,7 @@ mandatory fields or custom fields).
239238

240239
### Handle special references
241240

242-
- Some references have role of parent or child. This means that the child record doesn't make sense without its parent, for example a comment attached to a ticket. Assigning a `role` helps Airdrop correctly handle such fields in case the end-user decides to filter some of the parent records out.
241+
- Some references have role of parent or child. This means that the child record doesn't make sense without its parent, for example a comment attached to a ticket. Assigning a `reference_type` helps Airdrop correctly handle such fields in case the end-user decides to filter some of the parent records out.
243242

244243
- Sometimes the external system uses references besides the primary key of records, for example when referring to a case by serial number, or to a user by their email. To correctly resolve such references, they must be marked with 'by_field', which must be a field existing in that record type, marked 'is_identifier'. For example:
245244
```json

0 commit comments

Comments
 (0)