Skip to content

Commit 08b67cc

Browse files
fix all links (#55)
1 parent 740cb81 commit 08b67cc

15 files changed

+56
-56
lines changed

fern/docs/pages/concepts.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ A connection uses a keyring object to provide authentication, access token refre
2828

2929
## Event source
3030

31-
[Event sources](/snap-in-development/references/event-sources) collect events from webhooks, emails, and timer-based API calls. Events can also be manually published. DevRev supports the ingestion of webhooks from any source. Each event source is assigned to a dev org.
31+
[Event sources](/snapin-development/references/event-sources) collect events from webhooks, emails, and timer-based API calls. Events can also be manually published. DevRev supports the ingestion of webhooks from any source. Each event source is assigned to a dev org.
3232

3333
For example, if you want to collect webhook events from an organization's GitHub, create an event source which in turn gives us a URL to subscribe to on GitHub. Webhook events published to this URL are available from this event source.
3434

3535
## Function
3636

37-
The framework for executing code provided by users is [functions](/snap-in-development/references/functions). Currently, Javascript/TypeScript can be taken as input from the user and deployed as a function.
37+
The framework for executing code provided by users is [functions](/snapin-development/references/functions). Currently, Javascript/TypeScript can be taken as input from the user and deployed as a function.
3838

3939
Connection values can be passed to a function at runtime, enabling it to execute API calls to DevRev and to external systems such as GitHub, Slack, Bitbucket, and Discord.
4040

@@ -44,17 +44,17 @@ Snap-ins can be configured to enable and disable features, based on custom input
4444

4545
## Commands
4646

47-
A user can trigger [commands](/snap-in-development/references/commands) on different surfaces based on some parameters. Once a command is executed, a function is triggered.
47+
A user can trigger [commands](/snapin-development/references/commands) on different surfaces based on some parameters. Once a command is executed, a function is triggered.
4848

4949
A developer can develop commands to be included in a snap-in Version along with associated functions. These commands are installed when the snap-in is installed.
5050

5151
As part of the snap-in, commands have access to keyrings, global variables, and event sources.
5252

5353
## Hooks
5454

55-
[Hooks](/snap-in-development/references/hooks) enable developers to invoke functions when various events in the lifecycle of a snap-in occur. Hooks can be used to perform various actions based on the event such as validating the snap-in inputs and keyrings when the configuration is updated, registering event-sources and webhooks in external platforms when snap-in is activated, or setting custom fields to be used by the snap-in.
55+
[Hooks](/snapin-development/references/hooks) enable developers to invoke functions when various events in the lifecycle of a snap-in occur. Hooks can be used to perform various actions based on the event such as validating the snap-in inputs and keyrings when the configuration is updated, registering event-sources and webhooks in external platforms when snap-in is activated, or setting custom fields to be used by the snap-in.
5656

57-
Detailed documentation on hooks can be found in the [hooks reference](/snap-in-development/references/hooks).
57+
Detailed documentation on hooks can be found in the [hooks reference](/snapin-development/references/hooks).
5858

5959
## States
6060

@@ -76,7 +76,7 @@ The following diagram illustrates the transitions between different states.
7676

7777
## Snap-kit
7878

79-
[Snap-kit](/snap-in-development/references/snapkit) defines UI customization components. It's defined in the snap-in package and used to display developer-defined components. A snap-kit component can display data to a user or collect input for triggering a function.
79+
[Snap-kit](/snapin-development/references/snapkit) defines UI customization components. It's defined in the snap-in package and used to display developer-defined components. A snap-kit component can display data to a user or collect input for triggering a function.
8080

8181
## Marketplace
8282

fern/docs/pages/developer-intro.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A brief [tutorial](/api-reference/getting-started) shows you how to access the A
1010

1111
Specifications covering the supported APIs are based on OpenAPI Specification 3.0. You can download the specs to use an OpenAPI 3.0-compliant tool to perform a variety of actions, including rendering them in UI and generating SDKs. Two [versions](/about/versioning) of the DevRev API are available: [public](/public) and [beta](/beta) (early access). Use the drop-down menu in the upper-left corner of this site to switch between versions.
1212

13-
To take action based on events from the DevRev platform, [webhooks](/guides/getting-started-with-webhooks) are also supported.
13+
To take action based on events from the DevRev platform, [webhooks](/guides/webhooks) are also supported.
1414
<Cards>
1515
<Card
1616
title="Public"
@@ -27,7 +27,7 @@ To take action based on events from the DevRev platform, [webhooks](/guides/gett
2727

2828
## 🧩 Snap-ins
2929

30-
Numerous snap-ins are available on the DevRev [Marketplace](https://devrev.ai/marketplace). The [snap-in framework](/snap-in-development/concepts) is available for you to create your own snap-ins for automation of DevRev workflows or integration with other system.
30+
Numerous snap-ins are available on the DevRev [Marketplace](https://devrev.ai/marketplace). The [snap-in framework](/snapin-development/concepts) is available for you to create your own snap-ins for automation of DevRev workflows or integration with other system.
3131

3232
## 💻 SDKs
3333

fern/docs/pages/publish_to_marketplace.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,11 @@ The publishing process commences by initiating a marketplace submission, which e
3434

3535
## Get started
3636

37-
To get started with publishing marketplace item, you need DevRev CLI. Refer to [DevRev CLI Cheatsheet](/snap-in-development/references/install-dev-rev-cli) for more information.
37+
To get started with publishing marketplace item, you need DevRev CLI. Refer to [DevRev CLI Cheatsheet](/snapin-development/references/install-dev-rev-cli) for more information.
3838

3939
### Create a snap-in
4040

41-
To proceed with making a submission in marketplace, you need a snap-in for which you are creating this submission. If you are new to snap-ins, [follow the development and deployment guide](/snap-in-development/tutorials/overview) to create your first snap-in.
41+
To proceed with making a submission in marketplace, you need a snap-in for which you are creating this submission. If you are new to snap-ins, [follow the development and deployment guide](/snapin-development/tutorials/overview) to create your first snap-in.
4242

4343
## Create marketplace listing
4444

fern/docs/pages/references/cli.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -312,7 +312,7 @@ The `--force` flag deletes the snap-in even if the `deactivate` hook fails. If t
312312

313313
## Snap-in context
314314

315-
The CLI persists in the context of the CLI in a [snap-in context](#snap-in-context). The context is used to store the following information per snap-in package slug:
315+
The CLI persists in the context of the CLI in a snap-in context. The context is used to store the following information per snap-in package slug:
316316

317317
1. The ID of the snap-in package owning the slug.
318318
2. The ID of the last created/upgraded snap-in version, if any.

fern/docs/pages/references/functions.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Using functions, you can provide custom code and link it to your event sources, automations, or snap-kit actions. Functions are written in JavaScript and can be used to transform events, send notifications, or perform any other custom logic including network calls.
22

3-
In order to create a snap-in version, functions must be defined as shown in the [code samples](/snap-in-development/code-samples). Functions are packaged and provided as an artifact at the time of snap-in version creation and then used to deploy functions to snap-in versions. An artifact may contain multiple function definitions. The artifact is a zip file containing the following files:
3+
In order to create a snap-in version, functions must be defined as shown in the [code samples](/snapin-development/code-samples). Functions are packaged and provided as an artifact at the time of snap-in version creation and then used to deploy functions to snap-in versions. An artifact may contain multiple function definitions. The artifact is a zip file containing the following files:
44

55
```bash
66
/
@@ -26,4 +26,4 @@ functions:
2626
- `name`: It is the function name that should match the corresponding function name in the folder.
2727
- `description`: It describes the function.
2828

29-
Refer to the [function invocation](/snap-in-development/references/function-invocation) for details about the exact payload of the function.
29+
Refer to the [function invocation](/snapin-development/references/function-invocation) for details about the exact payload of the function.

fern/docs/pages/references/hooks.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ hooks:
1818
function: update-resource
1919
```
2020
21-
The above definition would register the hooks and invoke the provided functions alongside each hook. The functions can be defined in the manifest and provided in the code as explained in the [functions reference](/snap-in-development/references/functions).
21+
The above definition would register the hooks and invoke the provided functions alongside each hook. The functions can be defined in the manifest and provided in the code as explained in the [functions reference](/snapin-development/references/functions).
2222
23-
For the event schema received by the function invocation, refer to the [function invocation reference](/snap-in-development/references/function-invocation).
23+
For the event schema received by the function invocation, refer to the [function invocation reference](/snapin-development/references/function-invocation).
2424
2525
The event name is the identifier for the hook. The event name can be used to identify the hook that's being invoked. The identifiers are defined in the summary table below.
2626

fern/docs/pages/references/manifest.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Keyrings defined in the manifest can be provided in the snap-in configuration sc
6161
6262
Organization keyrings are common to the organization, while user keyrings are set per user. User keyrings are optional, so the developer must correctly handle cases where the keyring isn't found.
6363
64-
To view the supported connection types, see [Keyrings](/snap-in-development/references/keyrings).
64+
To view the supported connection types, see [Keyrings](/snapin-development/references/keyrings).
6565
6666
## Developer keyrings
6767
@@ -143,7 +143,7 @@ Event sources can be categorized as "organization" level and "user" level. Event
143143
144144
```
145145

146-
Refer to [Event sources](/snap-in-development/references/event-sources) for a checklist of supported event sources and their corresponding event types.
146+
Refer to [Event sources](/snapin-development/references/event-sources) for a checklist of supported event sources and their corresponding event types.
147147

148148
Refer to the webhook event-request example for a list of supported webhooks:
149149

fern/docs/pages/references/v1-manifest.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ connections:
4040
- devrev-github-oauth
4141
```
4242
43-
Service that stores these secrets and has the business logic to refresh tokens, when applicable. Here is the list of currently supported connection types - [Connections](/snap-in-development/references/keyrings)
43+
Service that stores these secrets and has the business logic to refresh tokens, when applicable. Here is the list of currently supported connection types - [Connections](/snapin-development/references/keyrings)
4444
4545
## Developer connections
4646
@@ -106,7 +106,7 @@ Event sources are specified in the manifest with the following syntax:
106106
type: <enum specifying what type of the source should be created>
107107
```
108108
109-
Here is the [list of supported event sources](/snap-in-development/references/event-sources).
109+
Here is the [list of supported event sources](/snapin-development/references/event-sources).
110110
111111
Example:
112112

fern/docs/pages/snapin-concepts.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ A connection uses a keyring object to provide authentication, access token refre
2929

3030
## Event source
3131

32-
[Event sources](/snap-in-development/references/event-sources) collect events from webhooks, emails, and timer-based API calls. Events can also be manually published. DevRev supports the ingestion of webhooks from any source. Each event source is assigned to a dev org.
32+
[Event sources](/snapin-development/references/event-sources) collect events from webhooks, emails, and timer-based API calls. Events can also be manually published. DevRev supports the ingestion of webhooks from any source. Each event source is assigned to a dev org.
3333

3434
For example, if you want to collect webhook events from an organization's GitHub, create an event source that gives you a URL to subscribe to on GitHub. Webhook events published to this URL are available from this event source.
3535

3636
## Function
3737

38-
The framework for executing code provided by users is [functions](/snap-in-development/references/functions). Currently, Javascript/TypeScript can be taken as input from the user and deployed as a function.
38+
The framework for executing code provided by users is [functions](/snapin-development/references/functions). Currently, Javascript/TypeScript can be taken as input from the user and deployed as a function.
3939

4040
Connection values can be passed to a function at runtime, enabling it to execute API calls to DevRev and external systems such as GitHub, Slack, Bitbucket, and Discord.
4141

@@ -45,17 +45,17 @@ Snap-ins can be configured to enable and disable features, based on custom input
4545

4646
## Commands
4747

48-
A user can trigger [commands](/snap-in-development/references/commands) on different surfaces based on some parameters. Once a command is executed, a function is triggered.
48+
A user can trigger [commands](/snapin-development/references/commands) on different surfaces based on some parameters. Once a command is executed, a function is triggered.
4949

5050
A developer can develop commands to be included in a snap-in version along with associated functions. These commands are installed when the snap-in is installed.
5151

5252
As part of the snap-in, commands have access to keyrings, global variables, and event sources.
5353

5454
## Hooks
5555

56-
[Hooks](/snap-in-development/references/hooks) enable developers to invoke functions when various events in the lifecycle of a snap-in occur. Hooks can be used to perform various actions based on the event such as validating the snap-in inputs and keyrings when the configuration is updated, registering event sources and webhooks in external platforms when snap-in is activated, or setting custom fields to be used by the snap-in.
56+
[Hooks](/snapin-development/references/hooks) enable developers to invoke functions when various events in the lifecycle of a snap-in occur. Hooks can be used to perform various actions based on the event such as validating the snap-in inputs and keyrings when the configuration is updated, registering event sources and webhooks in external platforms when snap-in is activated, or setting custom fields to be used by the snap-in.
5757

58-
Detailed documentation on hooks can be found in the [hooks reference](/snap-in-development/references/hooks).
58+
Detailed documentation on hooks can be found in the [hooks reference](/snapin-development/references/hooks).
5959

6060
## States
6161

@@ -81,7 +81,7 @@ Snap-in resources are user-level objects like keyrings, event sources, and input
8181

8282
## Snap-kit
8383

84-
[Snap-kit](/snap-in-development/references/snapkit) defines UI customization components. It's defined in the snap-in package and used to display developer-defined components. A snap-kit component can display data to a user or collect input for triggering a function.
84+
[Snap-kit](/snapin-development/references/snapkit) defines UI customization components. It's defined in the snap-in package and used to display developer-defined components. A snap-kit component can display data to a user or collect input for triggering a function.
8585

8686
## Marketplace
8787

fern/docs/pages/start.mdx

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

99
### Installation guide
1010

11-
- Install [DevRev CLI](/snap-in-development/references/install-dev-rev-cli)
11+
- Install [DevRev CLI](/snapin-development/references/cli-install)
1212
- Install [jq](https://stedolan.github.io/jq)
1313

1414
### Log in to DevRev for authentication
@@ -57,24 +57,24 @@ devrev-snaps-typescript-template/
5757

5858
The command creates a folder `devrev-snaps-typescript-template`. This contains a `manifest.yaml` file and a `code` folder.
5959

60-
- `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](/snap-in-development/references/snap-in-manifest).
60+
- `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).
6161
- `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).
6262

6363
### Creating a snap-in package
6464

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

6767
```bash
6868
devrev snap_in_package create-one --slug my-first-snap-in | jq .
6969
```
7070
<Callout intent="note">
7171
1. The slug is globally unique. If the slug provided is already taken, a conflict error occurs. This can be resolved by provided a different slug.
72-
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](/snap-in-development/references/install-dev-rev-cli).
72+
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).
7373
</Callout>
7474

7575
### Creating a snap-in version
7676

77-
To create a [snap-in version](/snap-in-development/concepts), run the following command:
77+
To create a [snap-in version](/snapin-development/references/cli#snap-in-version), run the following command:
7878

7979
```bash
8080
devrev snap_in_version create-one --path ./devrev-snaps-typescript-template | jq .
@@ -90,7 +90,7 @@ Output:
9090
}
9191
```
9292
<Callout intent="info">
93-
The CLI automatically stores the version ID in its context. Refer to the [Snap-in Context](/snap-in-development/references/install-dev-rev-cli) section for more information.
93+
The CLI automatically stores the version ID in its context. Refer to the [Snap-in Context](/snapin-development/references/cli#snap-in-context) section for more information.
9494
</Callout>
9595

9696
In a package that's not published to the marketplace, you can have only one snap-in version. If you have an existing snap-in version in the package, the following error message is shown:
@@ -130,7 +130,7 @@ To install the snap-in, you must be a member of the **Admins** group in the de
130130
<br />
131131

132132
<Callout intent="info">
133-
The CLI automatically stores the snap-in ID in its context. Refer to the [Snap-in Context](/snap-in-development/references/install-dev-rev-cli) section for more information.
133+
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.
134134
</Callout>
135135

136136
### Configuring the snap-in
@@ -172,6 +172,6 @@ devrev snap_in_version upgrade --path ./
172172

173173
The above expects the manifest file to be present in the current directory by the name `manifest.yaml` and the code to be present in the `code` directory.
174174

175-
Refer to [upgrade command](/snap-in-development/upgrade-snap-ins) for more information.
175+
Refer to [upgrade command](/snapin-development/upgrade-snap-ins) for more information.
176176

177177
</Steps>

0 commit comments

Comments
 (0)