Skip to content

Improve Getting started guide for snap-ins #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 28, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions fern/docs/pages/start.mdx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Suggestions:

  • Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
  • Remove 'separately ' if it's not important to the meaning of the statement. (EK00006)

Snap-ins are collections of objects that extend DevRev's core platform value. These objects include automation, event sources, keyrings, custom types, and vistas. Snap-ins are packaged and installed separately from the DevRev core platform. To create your own snap-in, create a [dev org](https://app.devrev.ai/) where you will be installing your snap-in.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [EkLine] reported by reviewdog 🐶

Use 'snap-in' instead of 'Snap-in'. (EK25050)

- `manifest` file defines the resources to be created on the DevRev platform. For detailed information on the various components of a manifest file, see [Snap-in Manifest](/snapin-development/references/manifest).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Suggestions:

    In general, don't use an ellipsis. (EK00011)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

Suggestions:

  • Where possible, do not structure sentences in future tense. Use present tense instead. (EK00005)
  • Use the Oxford comma in 'deploying, deleting and upgrading'. (EK00039)

In this tutorial, you'll learn to create and deploy a snap-in. Additionally, you'll learn to create a snap-in version, installing from a version, deploying, deleting and upgrading the snap-in.

Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ devrev snap_in draft
To install the snap-in, you must be a member of the **Admins** group in the dev org.
</Callout>

<Callout intent="info">
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.
</Callout>

<br />

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

### Check snap-in logs

To check the logs for the snap-in, run the following command:

```bash
devrev snap_in_package logs | jq
```

### Delete the snap-in

The snap-in can be deleted from the UI or run the following command:
Expand Down
5 changes: 2 additions & 3 deletions fern/docs/pages/tutorials/timer-ticket-creator.mdx
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [EkLine] reported by reviewdog 🐶

In general, don't use an ellipsis. (EK00011)

Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ The objective is to build a snap-in that creates a new ticket every 10 minutes.

## Background context

In the [Getting Started](/snapin-development/tutorials/getting-started) tutorial, you learned how to create a
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:

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.
This tutorial makes the following changes to the snap-in:
1. Update the trigger condition to run every 10 minutes instead of work
creation.
2. Create a ticket whenever the snap-in is triggered.
Expand Down
Loading