Skip to content

Commit e655057

Browse files
committed
Improve Getting started guide
1 parent ecf87b8 commit e655057

File tree

2 files changed

+14
-3
lines changed

2 files changed

+14
-3
lines changed

fern/docs/pages/start.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,10 @@ devrev snap_in draft
125125
To install the snap-in, you must be a member of the **Admins** group in the dev org.
126126
</Callout>
127127

128+
<Callout intent="info">
129+
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.
130+
</Callout>
131+
128132
<br />
129133

130134
<Callout intent="info">
@@ -150,6 +154,14 @@ To make a connection available to other members in your organization, create it
150154
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.
151155
That's it, the snap-in should now be active and ready to use.
152156

157+
### Check snap-in logs
158+
159+
To check the logs for the snap-in, run the following command:
160+
161+
```bash
162+
devrev snap_in_package logs | jq
163+
```
164+
153165
### Delete the snap-in
154166

155167
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 will make 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)