Skip to content

Commit 7592a19

Browse files
Improve Getting started guide for snap-ins (#158)
* Improve Getting started guide * Update fern/docs/pages/tutorials/timer-ticket-creator.mdx Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * merge notes --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent bc15363 commit 7592a19

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

fern/docs/pages/start.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,8 @@ devrev snap_in draft
122122
```
123123

124124
<Callout intent="note">
125-
To install the snap-in, you must be a member of the **Admins** group in the dev org.
125+
1. To install the snap-in, you must be a member of the **Admins** group in the dev org.
126+
2. If you get a `snap-in version is not ready` error, check the version state with `devrev snap_in_version show`. The state should be `ready` for installation. If `build_failed`, check the logs for errors.
126127
</Callout>
127128

128129
<br />
@@ -150,6 +151,14 @@ To make a connection available to other members in your organization, create it
150151
Once you have provided the required configuration, the **Deploy snap-in** button is enabled on the UI. Click on it to deploy the snap-in.
151152
That's it, the snap-in should now be active and ready to use.
152153

154+
### Check snap-in logs
155+
156+
To check the logs for the snap-in, run the following command:
157+
158+
```bash
159+
devrev snap_in_package logs | jq
160+
```
161+
153162
### Delete the snap-in
154163

155164
The snap-in can be deleted from the UI or run the following command:

fern/docs/pages/tutorials/timer-ticket-creator.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@ The objective is to build a snap-in that creates a new ticket every 10 minutes.
44

55
## Background context
66

7-
In the [Getting Started](/snapin-development/tutorials/getting-started) tutorial, you learned how to create a
8-
hello-world snap-in which prints a log message when a work item is created. In this tutorial, you will make the following changes to the snap-in:
9-
7+
The [Getting Started](/snapin-development/tutorials/getting-started) tutorial creates a hello-world snap-in which prints a log message when a work item is created.
8+
This tutorial makes the following changes to the snap-in:
109
1. Update the trigger condition to run every 10 minutes instead of work
1110
creation.
1211
2. Create a ticket whenever the snap-in is triggered.

0 commit comments

Comments
 (0)