Skip to content

Commit e3de978

Browse files
fix link typos
1 parent acc8de5 commit e3de978

File tree

28 files changed

+85
-85
lines changed

28 files changed

+85
-85
lines changed

docs-v2/pages/connect/api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -403,7 +403,7 @@ GET /{project_id}/accounts/
403403

404404
The ID or name slug the app you'd like to retrieve. For example, Slack's unique app ID is `app_OkrhR1`, and its name slug is `slack`.
405405

406-
You can find the app's ID in the response from the [List apps]((/core/rest-api/#list-apps) endpoint, and the name slug under the **Authentication** section of any [app page](https://pipedream.com/apps).
406+
You can find the app's ID in the response from the [List apps](/core/rest-api/#list-apps) endpoint, and the name slug under the **Authentication** section of any [app page](https://pipedream.com/apps).
407407

408408
---
409409

@@ -1113,7 +1113,7 @@ The ID or name slug the app you'd like to retrieve. For example, Slack's unique
11131113
app ID is `app_OkrhR1`, and its name slug is `slack`.
11141114

11151115
You can find the app's ID in the response from the [List
1116-
apps]((/core/rest-api/#list-apps) endpoint, and the name slug under the
1116+
apps](/core/rest-api/#list-apps) endpoint, and the name slug under the
11171117
**Authentication** section of any [app page](https://pipedream.com/apps).
11181118

11191119
---

docs-v2/pages/connect/components.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Check out the [public demo app](https://pdrm.co/connect) to see the API and SDK
3333
<Callout type="info">
3434
Refer to the [Connect API docs](/connect/api/) for the full API reference. Below is a quickstart with a few specific examples.
3535

36-
You can skip steps 1 and 2 if you already know the component you want to use or if you'd prefer to [pass a natural language prompt to Pipedream's component search API]((/core/rest-api/#search-for-registry-components).
36+
You can skip steps 1 and 2 if you already know the component you want to use or if you'd prefer to [pass a natural language prompt to Pipedream's component search API](/core/rest-api/#search-for-registry-components).
3737
</Callout>
3838

3939
<Steps>
@@ -676,9 +676,9 @@ above:
676676

677677
#### Deploying a source
678678

679-
Because sources are exercised by events that happen on a third-party service,
680-
their semantics are different from actions. Once a source is configured, it must
681-
be deployed to start listening for events. When deploying a source, you
679+
Because sources are exercised by events that happen on a third-party service,
680+
their semantics are different from actions. Once a source is configured, it must
681+
be deployed to start listening for events. When deploying a source, you
682682
can define either a webhook URL or a Pipedream workflow ID to consume those events.
683683

684684
Deploying a source is done by sending a payload similar to the one used for

docs-v2/pages/connect/managed-auth/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ You'll need these when configuring the SDK and making API requests.
7474

7575
### Generate a short-lived token
7676

77-
To securely initiate account connections for your users, you'll need generate a short-lived token for your users and use that in the [account connection flow](#connect-your-users-account). See [the docs on Connect tokens](/connect/tokens/) for a general overview of why we need to create tokens and scope them to end users.
77+
To securely initiate account connections for your users, you'll need to generate a short-lived token for your users and use that in the [account connection flow](#connect-your-users-account). See [the docs on Connect tokens](/connect/tokens/) for a general overview of why we need to create tokens and scope them to end users.
7878

7979
In the Next.js example here, we're running [Next server components](https://nextjs.org/docs/app/building-your-application/rendering/server-components) in `app/server.ts`. We call the `serverConnectTokenCreate` method from the frontend to retrieve a token **for a specific user**.
8080

docs-v2/pages/connect/workflows.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,11 +263,11 @@ You have two options for triggering workflows that run on behalf of your end use
263263

264264
### HTTP Webhook
265265

266-
The most common way to trigger workflows is via HTTP webhook. We strongly recommend [creating a Pipedream OAuth client]((/core/rest-api/auth#creating-an-oauth-client) and authenticating inbound requests to your workflows.
266+
The most common way to trigger workflows is via HTTP webhook. We strongly recommend [creating a Pipedream OAuth client](/core/rest-api/auth#creating-an-oauth-client) and authenticating inbound requests to your workflows.
267267

268268
To get started, you'll need:
269269

270-
- [OAuth client ID and secret]((/core/rest-api/auth#creating-an-oauth-client) (optional but recommended)
270+
- [OAuth client ID and secret](/core/rest-api/auth#creating-an-oauth-client) (optional but recommended)
271271
- Your [project ID](/core/projects/#finding-your-projects-id)
272272
- Your workflow's HTTP endpoint URL
273273
- The [external user ID](/connect/api/#external-users) of your end user

docs-v2/pages/core/cli/reference.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ Generate new app and component files from templates.
121121

122122
#### `pd init app`
123123

124-
Creates a directory and [an app file](/(/core/core/contributing/components/guidelines/#app-files) from a template
124+
Creates a directory and [an app file](/core/core/contributing/components/guidelines/#app-files) from a template
125125

126126
```bash
127127
# Creates google_calendar/ directory and google_calendar.mjs file
@@ -146,7 +146,7 @@ Creates a new directory and [an event source](/core/workflows/triggers/) from a
146146
pd init source cancelled-event
147147
```
148148

149-
You can attach [database](/core/contributing/components/api//#db), [HTTP](/core/contributing/components/api//#http), or [Timer](/core/contributing/components/api//#timer) props to your template using the following flags:
149+
You can attach [database](/core/contributing/components/api/#db), [HTTP](/core/contributing/components/api/#http), or [Timer](/core/contributing/components/api/#timer) props to your template using the following flags:
150150

151151
| Prop type | Flag |
152152
| --------- | --------- |

docs-v2/pages/core/contributing/components/actions-quickstart.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ We recommend that you complete the examples below in order.
5757

5858
### hello world!
5959

60-
The following code represents a simple component that can be published as an action ([learn more](/core/contributing/components/api//) about the component structure). When used in a workflow, it will export `hello world!` as the return value for the step.
60+
The following code represents a simple component that can be published as an action ([learn more](/core/contributing/components/api/) about the component structure). When used in a workflow, it will export `hello world!` as the return value for the step.
6161

6262
```javascript
6363
export default {
@@ -109,7 +109,7 @@ Keep the browser tab open. We'll return to this workflow in the rest of the exam
109109

110110
### hello [name]!
111111

112-
Next, let's update the component to capture some user input. First, add a `string` [prop](/core/contributing/components/api//#props) called `name` to the component.
112+
Next, let's update the component to capture some user input. First, add a `string` [prop](/core/contributing/components/api/#props) called `name` to the component.
113113

114114
```java
115115
export default {
@@ -340,7 +340,7 @@ export default {
340340
};
341341
```
342342

343-
Then add an [app prop](/core/contributing/components/api//#app-props) to use Pipedream managed auth with this component. For this example, we'll add an app prop for Github:
343+
Then add an [app prop](/core/contributing/components/api/#app-props) to use Pipedream managed auth with this component. For this example, we'll add an app prop for Github:
344344

345345
```javascript
346346
import { Octokit } from "@octokit/rest";
@@ -397,7 +397,7 @@ export default {
397397
};
398398
```
399399

400-
In order to help users understand what's happening with each action step, we recommend surfacing a brief summary with `$summary` ([read more](/core/contributing/components/api//#actions) about exporting data using `$.export`).
400+
In order to help users understand what's happening with each action step, we recommend surfacing a brief summary with `$summary` ([read more](/core/contributing/components/api/#actions) about exporting data using `$.export`).
401401

402402
```javascript
403403
import { Octokit } from "@octokit/rest";
@@ -486,6 +486,6 @@ Select an existing account or connect a new one, and then deploy your workflow a
486486

487487
## What's Next?
488488

489-
You're ready to start authoring and publishing actions on Pipedream! You can also check out the [detailed component reference](/core/contributing/components/api//#component-api) at any time!
489+
You're ready to start authoring and publishing actions on Pipedream! You can also check out the [detailed component reference](/core/contributing/components/api/#component-api) at any time!
490490

491491
If you have any questions or feedback, please [reach out](https://pipedream.com/community)!

docs-v2/pages/core/contributing/components/guidelines.mdx

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ scoped components are easier for users to understand and use.
113113

114114
### Required Metadata
115115

116-
Registry [components](/core/contributing/components/api//#component-structure) require a unique
116+
Registry [components](/core/contributing/components/api/#component-structure) require a unique
117117
`key` and `version`, and a friendly `name` and `description`. Action components
118118
require a `type` field to be set to `action` (sources will require a type to be
119119
set in the future).
@@ -195,7 +195,7 @@ directory](https://github.com/PipedreamHQ/pipedream/tree/master/components).
195195
#### Using APIs vs Client Libraries
196196

197197
If the app has a well-supported [Node.js client
198-
library](/core/contributing/components/api//#using-npm-packages), feel free to use that instead of
198+
library](/core/contributing/components/api/#using-npm-packages), feel free to use that instead of
199199
manually constructing API requests.
200200

201201
### `package.json`
@@ -321,7 +321,7 @@ logic should:
321321
#### Capturing Sensitive Data
322322

323323
If users are required to enter sensitive data, always use
324-
[secret](/core/contributing/components/api//#general) props.
324+
[secret](/core/contributing/components/api/#general) props.
325325

326326
### Promoting Reusability
327327

@@ -336,15 +336,15 @@ out](https://pipedream.com/community/c/dev/11).
336336
##### Prop Definitions
337337

338338
Whenever possible, reuse existing [prop
339-
definitions](/core/contributing/components/api//#prop-definitions-example).
339+
definitions](/core/contributing/components/api/#prop-definitions-example).
340340

341341
If a prop definition does not exist and you are adding an app-specific prop that
342342
may be reused in future components, add it as a prop definition to the app file.
343343
Prop definitions will also be surfaced for apps the Pipedream marketplace.
344344

345345
##### Methods
346346

347-
Whenever possible, reuse [methods](/core/contributing/components/api//#methods) defined in the app
347+
Whenever possible, reuse [methods](/core/contributing/components/api/#methods) defined in the app
348348
file. If you need to use an API for which a method is not defined and it may be
349349
used in future components, define a new method in the app file.
350350

@@ -436,7 +436,7 @@ simply as possible.
436436

437437
### Labels
438438

439-
Use [prop](/core/contributing/components/api//#user-input-props) labels to customize the name of a
439+
Use [prop](/core/contributing/components/api/#user-input-props) labels to customize the name of a
440440
prop or propDefinition (independent of the variable name in the code). The label
441441
should mirror the name users of an app are familiar with; i.e., it should mirror
442442
the equivalent label in the app’s UI. This applies to usage in labels,
@@ -445,7 +445,7 @@ but its label is set to “Search Term”.
445445

446446
### Descriptions
447447

448-
Include a description for [props](/core/contributing/components/api//#user-input-props) if it helps
448+
Include a description for [props](/core/contributing/components/api/#user-input-props) if it helps
449449
the user understand what they need to do. Use Markdown as appropriate to improve
450450
the clarity of the description or instructions. When using Markdown:
451451

@@ -474,7 +474,7 @@ Examples:
474474

475475
### Optional vs Required Props
476476

477-
Use optional [props](/core/contributing/components/api//#user-input-props) whenever possible to
477+
Use optional [props](/core/contributing/components/api/#user-input-props) whenever possible to
478478
minimize the input fields required to use a component.
479479

480480
For example, the Twitter search mentions source only requires that a user
@@ -486,7 +486,7 @@ activate the source:
486486

487487
### Default Values
488488

489-
Provide [default values](/core/contributing/components/api//#user-input-props) whenever possible.
489+
Provide [default values](/core/contributing/components/api/#user-input-props) whenever possible.
490490
NOTE: the best default for a source doesn’t always map to the default
491491
recommended by the app. For example, Twitter defaults search results to an
492492
algorithm that balances recency and popularity. However, the best default for
@@ -495,15 +495,15 @@ the use case on Pipedream is recency.
495495
### Async Options
496496

497497
Avoid asking users to enter ID values. Use [async
498-
options](/core/contributing/components/api//#async-options-example) (with label/value definitions)
498+
options](/core/contributing/components/api/#async-options-example) (with label/value definitions)
499499
so users can make selections from a drop down menu. For example, Todoist
500500
identifies projects by numeric IDs (e.g., 12345). The async option to select a
501501
project displays the name of the project as the label, so that’s the value the
502502
user sees when interacting with the source (e.g., “My Project”). The code
503503
referencing the selection receives the numeric ID (12345).
504504

505505
Async options should also support
506-
[pagination](/core/contributing/components/api//#async-options-example) (so users can navigate
506+
[pagination](/core/contributing/components/api/#async-options-example) (so users can navigate
507507
across multiple pages of options for long lists). See
508508
[Hubspot](https://github.com/PipedreamHQ/pipedream/blob/a9b45d8be3b84504dc22bb2748d925f0d5c1541f/components/hubspot/hubspot.app.mjs#L136)
509509
for an example of offset-based pagination. See
@@ -512,7 +512,7 @@ for an example of cursor-based pagination.
512512

513513
### Dynamic Props
514514

515-
[Dynamic props](/core/contributing/components/api//#dynamic-props) can improve the user experience
515+
[Dynamic props](/core/contributing/components/api/#dynamic-props) can improve the user experience
516516
for components. They let you render props in Pipedream dynamically, based on the
517517
value of other props, and can be used to collect more specific information that
518518
can make it easier to use the component. See the Google Sheets example in the
@@ -521,8 +521,8 @@ linked component API docs.
521521
### Interface & Service Props
522522

523523
In the interest of consistency, use the following naming patterns when defining
524-
[interface](/core/contributing/components/api//#interface-props) and
525-
[service](/core/contributing/components/api//#service-props) props in source components:
524+
[interface](/core/contributing/components/api/#interface-props) and
525+
[service](/core/contributing/components/api/#service-props) props in source components:
526526

527527
| Prop | **Recommended Prop Variable Name** |
528528
| ------------------- | ---------------------------------- |
@@ -567,7 +567,7 @@ search criteria”.
567567

568568
### Emit a Summary
569569

570-
Always [emit a summary](/core/contributing/components/api//#emit) for each event. For example, the
570+
Always [emit a summary](/core/contributing/components/api/#emit) for each event. For example, the
571571
summary for each new Tweet emitted by the Search Mentions source is the content
572572
of the Tweet itself.
573573

@@ -576,7 +576,7 @@ format as the summary.
576576

577577
### Deduping
578578

579-
Use built-in [deduping strategies](/core/contributing/components/api//#dedupe-strategies) whenever
579+
Use built-in [deduping strategies](/core/contributing/components/api/#dedupe-strategies) whenever
580580
possible (`unique`, `greatest`, `last`) vs developing custom deduping code.
581581
Develop custom deduping code if the existing strategies do not support the
582582
requirements for a source.
@@ -673,17 +673,17 @@ of just letting the error bubble up).
673673

674674
#### Hooks
675675

676-
[Hooks](/core/contributing/components/api//#hooks) are methods that are automatically invoked by
676+
[Hooks](/core/contributing/components/api/#hooks) are methods that are automatically invoked by
677677
Pipedream at different stages of the [component
678-
lifecycle](/core/contributing/components/api//#source-lifecycle). Webhook subscriptions are
678+
lifecycle](/core/contributing/components/api/#source-lifecycle). Webhook subscriptions are
679679
typically created when components are instantiated or activated via the
680680
`activate()` hook, and deleted when components are deactivated or deleted via
681681
the `deactivate()` hook.
682682

683683
#### Helper Methods
684684

685685
Whenever possible, create methods in the app file to manage [creating and
686-
deleting webhook subscriptions](/core/contributing/components/api//#hooks).
686+
deleting webhook subscriptions](/core/contributing/components/api/#hooks).
687687

688688
| **Description** | **Method Name** |
689689
| --------------------------------------- | --------------- |
@@ -765,7 +765,7 @@ number of records to return.
765765

766766
### Use `$.summary` to Summarize What Happened
767767

768-
[Describe what happened](/core/contributing/components/api//#returning-data-from-steps) when an
768+
[Describe what happened](/core/contributing/components/api/#returning-data-from-steps) when an
769769
action succeeds by following these guidelines:
770770

771771
- Use plain language and provide helpful and contextually relevant information

docs-v2/pages/core/contributing/components/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ Finally, the target app must be integrated with Pipedream. You can explore all a
9999

100100
### Component API Reference
101101

102-
After getting familiar with source/action development using the quickstart guides, check out [the Component API Reference](/core/contributing/components/api//) and [examples on GitHub](https://github.com/PipedreamHQ/pipedream/tree/master/components) to learn more.
102+
After getting familiar with source/action development using the quickstart guides, check out [the Component API Reference](/core/contributing/components/api/) and [examples on GitHub](https://github.com/PipedreamHQ/pipedream/tree/master/components) to learn more.
103103

104104
## Managing Privately Published Components
105105

docs-v2/pages/core/contributing/components/sources-quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -679,6 +679,6 @@ Save and reload your source in the Pipedream UI. You should now see a countdown
679679

680680
## What's Next?
681681

682-
You're ready to start authoring and deploying components on Pipedream! You can also check out the [detailed component reference](/core/contributing/components/api//) at any time!
682+
You're ready to start authoring and deploying components on Pipedream! You can also check out the [detailed component reference](/core/contributing/components/api/) at any time!
683683

684684
If you have any questions or feedback, please join our [public Slack](https://pipedream.com/support).

docs-v2/pages/core/contributing/components/typescript.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ See [the RSS sources and actions](https://github.com/PipedreamHQ/pipedream/tree/
8888

8989
We welcome PRs in [the `PipedreamHQ/pipedream` repo](https://github.com/PipedreamHQ/pipedream), where we store all sources and actions, the `@pipedream/types` package, these docs, and other Pipedream code. Here are a few known issues durin the **beta**:
9090

91-
- `this` is strictly-typed within `methods`, `run`, `hooks`, and everywhere you have access to `this` in [the component API](/core/contributing/components/api//). But this typing can be improved. For example, we don't yet map props to their appropriate TypeScript type (everything is typed with `any`).
91+
- `this` is strictly-typed within `methods`, `run`, `hooks`, and everywhere you have access to `this` in [the component API](/core/contributing/components/api/). But this typing can be improved. For example, we don't yet map props to their appropriate TypeScript type (everything is typed with `any`).
9292
- The compile -> publish lifecycle hasn't been fully-automated when you're developing in the `pipedream` repo. Currently, you have to run `npm run build` from the repo root, then use the `pd` CLI to publish components after compilation. It would be nice to run `tsc-watch` and have that compile and publish the new version of the component using the `--onSuccess` flag, publishing any sources or actions accordingly.
9393
- We should add a linter (like `dtslint`) to all TypeScript components). Currently, `dtslint` is configured only for the `@pipedream/types` package.
9494

0 commit comments

Comments
 (0)