Skip to content

Commit ba967e7

Browse files
committed
steps
1 parent 320bf58 commit ba967e7

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

fern/docs/pages/start.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Snap-ins are collections of objects that extend DevRev's core platform value. Th
44

55
<Steps>
66

7-
### Installation guide
7+
### Before you begin
88

99
- Install [DevRev CLI](/snapin-development/references/cli-install)
1010
- Install [jq](https://stedolan.github.io/jq)
@@ -17,7 +17,7 @@ To authenticate, run the following command:
1717
devrev profiles authenticate -o <dev-org-slug> -u <[email protected]>
1818
```
1919

20-
### Initializing a snap-in template
20+
### Initialize a snap-in template
2121

2222
To initialize a snap-in template, run the following command:
2323

@@ -58,7 +58,7 @@ The command creates a folder `devrev-snaps-typescript-template`. This contains a
5858
- `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).
5959
- `code` folder consists of sample starter code for snap-ins. For detailed information on how to get started, see [starter example repo](https://github.com/devrev/snap-in-examples/tree/main/1-starter/code#readme).
6060

61-
### Creating a snap-in package
61+
### Create a snap-in package
6262

6363
To create a [snap-in package](/snapin-development/concepts), run the following command:
6464

@@ -70,7 +70,7 @@ devrev snap_in_package create-one --slug my-first-snap-in | jq .
7070
2. On successful creation, the CLI automatically stores the package ID in its context corresponding to the slug. For more information, refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context).
7171
</Callout>
7272

73-
### Creating a snap-in version
73+
### Create a snap-in version
7474

7575
To create a [snap-in version](/snapin-development/references/cli#snap-in-version), run the following command:
7676

@@ -113,7 +113,7 @@ To delete the snap-in version, run the following command:
113113
devrev snap_in_version delete-one
114114
```
115115

116-
### Installing a snap-in from a snap-in version
116+
### Install a snap-in from a snap-in version
117117

118118
To create a snap-in from a snap-in version, run the following command:
119119

@@ -131,7 +131,7 @@ To install the snap-in, you must be a member of the **Admins** group in the de
131131
The CLI automatically stores the snap-in ID in its context. Refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context) section for more information.
132132
</Callout>
133133

134-
### Configuring the snap-in
134+
### Configure the snap-in
135135

136136
The snap-in is installed in draft state. It may require some configuration before it can be deployed.
137137

@@ -145,12 +145,12 @@ Private keyrings from other creators aren't listed.
145145

146146
To make a connection available to other members in your organization, create it with the **visible to dev org** option set to true while creating the connection in the DevRev app.
147147

148-
### Deploying the snap-in
148+
### Deploy the snap-in
149149

150150
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.
151151
That's it, the snap-in should now be active and ready to use.
152152

153-
### Deleting the snap-in
153+
### Delete the snap-in
154154

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

@@ -160,7 +160,7 @@ devrev snap_in delete-one [snap-in id]
160160

161161
If any deactivate hook is specified, it's invoked with `is_deletion=true`.
162162

163-
### Upgrading the snap-in
163+
### Upgrade the snap-in
164164

165165
Once you deploy and test your snap-in, you may want to make changes to it. The changes can be done using a single command.
166166

0 commit comments

Comments
 (0)