Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
46eba10
remove stale docs
andrewjschuang Feb 10, 2025
4e9f570
remove github sync quickstart
andrewjschuang Feb 10, 2025
cfb19ac
pnpm
andrewjschuang Feb 10, 2025
e912c07
main restructure
andrewjschuang Feb 11, 2025
63e8c66
fix some broken links
andrewjschuang Feb 11, 2025
01bd0da
fix broken links
andrewjschuang Feb 11, 2025
151c41f
fix broken links
andrewjschuang Feb 11, 2025
2ec9d2f
fix broken links
andrewjschuang Feb 11, 2025
a226ebc
fix capitalization
andrewjschuang Feb 17, 2025
c2816ea
fix image links
andrewjschuang Feb 17, 2025
428490a
remove connect sdk dep
andrewjschuang Feb 17, 2025
ee8bed3
remove deprecated page
andrewjschuang Feb 17, 2025
378d8bc
rename to core
andrewjschuang Feb 17, 2025
5a1becf
move images to public folder
andrewjschuang Feb 17, 2025
409f958
add rewrites and remove stale hidden pages
andrewjschuang Feb 17, 2025
fe22e40
fix repage links
andrewjschuang Feb 18, 2025
23ad1ac
fix http urls
andrewjschuang Feb 18, 2025
674b550
faq
andrewjschuang Feb 18, 2025
313d956
code rabbit suggestions
andrewjschuang Feb 18, 2025
acc8de5
Merge branch 'master' into docs-structure-refactor
andrewjschuang Feb 18, 2025
e3de978
fix link typos
andrewjschuang Feb 18, 2025
2ef7372
more link fixes
andrewjschuang Feb 18, 2025
b63e470
code rabbit comments
andrewjschuang Feb 18, 2025
0a4d86d
fix link
andrewjschuang Feb 18, 2025
62b063f
move out integrations and rest-api. rename core to workflows
andrewjschuang Feb 20, 2025
53b1fad
fix paths for integrations, rest-api and workflows
andrewjschuang Feb 20, 2025
865d344
fix rest api, sse, and some other links
andrewjschuang Feb 20, 2025
32bb18d
rollback vercel.json
andrewjschuang Feb 20, 2025
f9f6774
update vercel.json redirects
andrewjschuang Feb 20, 2025
b79c606
pnpm
andrewjschuang Feb 20, 2025
0dfbf02
Merge branch 'master' into docs-structure-refactor
andrewjschuang Feb 20, 2025
72ce5f7
Merge branch 'master' into docs-structure-refactor
andrewjschuang Feb 21, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
6 changes: 3 additions & 3 deletions docs-v2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ We're moving from VuePress to Nextra. Here's what's the same and what's differen
- New docs are here, in the `docs-v2/` directory.
- All docs are still Markdown. Now MDX files instead of just Markdown, so extensions have been renamed to `.mdx`.
- Keep images in `public/images/foo.png`, reference with `![alt text](/images/foo.png)`
- Leaf nodes in VuePress were at files like `/docs/workspaces/sso/google/README.md`. Nextra allows leaf nodes to be non-index files like `/docs/workspaces/sso/google.mdx`, so there's no need for the final directory, which simplifies things.
- Leaf nodes in VuePress were at files like `/docs/workflows/workspaces/sso/google/README.md`. Nextra allows leaf nodes to be non-index files like `/docs/workflows/workspaces/sso/google.mdx`, so there's no need for the final directory, which simplifies things.
- VuePress used Vue, Nextra uses React. All of the custom components used in MDX files are either [built-in Nextra components](https://nextra.site/docs/guide/built-ins) or Pipedream-specific components in `components/`, ported from Vue.
- Learn the [built-in Nextra components](https://nextra.site/docs/guide/built-ins). All the `::: tip`, `::: warning`, or other special VuePress components have an equivalent Nextra component.

Expand Down Expand Up @@ -50,8 +50,8 @@ pages
workspaces/
index.mdx # /docs/workspaces
sso/
index.mdx # /docs/workspaces/sso
google.mdx # /docs/workspaces/sso/google
index.mdx # /docs/workflows/workspaces/sso
google.mdx # /docs/workflows/workspaces/sso/google
```

The `_meta.tsx` files in each directory defines a mapping between the labels in the sidebar and the files in that directory. If you want to add an item to the sidebar, you'll probably want to edit the `_meta.tsx` file. [See the Nextra docs](https://nextra.site/docs/docs-theme/page-configuration) for more info.
Expand Down
71 changes: 6 additions & 65 deletions docs-v2/pages/_meta.tsx
Original file line number Diff line number Diff line change
@@ -1,30 +1,12 @@
export default {
"index": "What is Pipedream?",
"quickstart": "Quickstart",
"workspaces": "Workspaces",
"projects": "Projects",
"workflows": "Workflows",
"connect": {
title: "Connect",
},
"code": "Code",
"data-stores": "Data Stores",
"databases": "Databases",
"connected-accounts": "Connected Accounts",
"apps": "Integrations",
"components": "Components",
"sources": "Sources",
"event-history": "Event History",
"http": "HTTP",
"environment-variables": "Environment Variables",
"rest-api": "REST API",
"cli": "CLI",
"destinations": "Destinations",
"user-settings": "User and Billing Settings",
"troubleshooting": "Troubleshooting",
"pricing": "Pricing FAQ",
"connect": "Connect",
"pricing": "Pricing",
"account": "Account",
"privacy-and-security": "Security",
"limits": "Limits",
"troubleshooting": "Troubleshooting",
"glossary": "Glossary of Terms",
"support": {
title: "Support",
Expand All @@ -44,51 +26,10 @@ export default {
href: "https://status.pipedream.com",
newWindow: true,
},
"version": {
title: "Version",
type: "menu",
items: {
v3: {
title: "Current",
href: "https://pipedream.com/docs",
},
v2: {
title: "Linear (classic)",
href: "https://pipedream.com/docs/v2",
},
},
},
"abuse": {
display: "hidden",
},
"airtable": {
display: "hidden",
},
"examples": {
display: "hidden",
},
"migrate-from-v1": {
display: "hidden",
},
"new-feature-or-bug": {
display: "hidden",
},
"nodejs20-faq-2024-02": {
display: "hidden",
},
"scheduling-future-tasks": {
display: "hidden",
},
"shopify-faq-2023-10": {
display: "hidden",
},
"subprocessors": {
display: "hidden",
},
"pipedream-axios": {
"deprecated": {
display: "hidden",
},
"status": {
"hidden": {
display: "hidden",
},
} as const
4 changes: 4 additions & 0 deletions docs-v2/pages/account/_meta.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
export default {
"user-settings": "User Settings",
"billing-settings": "Billing Settings",
} as const
43 changes: 43 additions & 0 deletions docs-v2/pages/account/billing-settings.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import Callout from '@/components/Callout'

# Billing Settings

You'll find information on your usage data (for specific [Pipedream limits](/workflows/limits/)) in your [Billing Settings](https://pipedream.com/settings/billing). You can also upgrade to [paid plans](https://pipedream.com/pricing) from this page.

## Subscription

You can upgrade to [paid plans](https://pipedream.com/pricing) from this section.

If you've already upgraded, you'll see an option to **Manage Subscription** here, which directs you to your personal Stripe portal. Here, you can change your payment method, review the details of previous invoices, and more.

## Usage

[Credits](/pricing/#credits) are Pipedream's billable unit, and users on the [free tier](/pricing/#free-tier) are limited on the number of daily free credits allocated. The **Usage** section displays a chart of the daily credits across a historical range of time to provide insight into your usage patterns.

Hover over a specific column in the chart to see the number of credits run for that specific day:

![Daily credits tooltip](./images/daily-invocations-tooltip.png)

_Click_ on a specific column to see credits for that day, broken out by workflow / source:

![Credits broken out by workflow / source](./images/usage-by-resource.png)

Users on the free tier will see the last 30 days of usage in this chart. Users on [paid plans](https://pipedream.com/pricing) will see the cumulative usage tied to their current billing period.

## Compute Budget

Control the maximum number of compute credits permitted on your account with an _Credit Budget_.

This will restrict your account-wide usage to the specified number of [credits](/pricing/#credits) on a monthly or daily basis. The compute budget does not apply to credits incurred by [dedicated workers](/workflows/visual-builder/settings/#eliminate-cold-starts).

To enable this feature, _click_ on the toggle and define your maximum number of credits in the period.

<Callout type="info">
Due to how credits are accrued, there may be cases where your credit usage may _slightly_ go over the cap.

In an example scenario, with cap set at 20 credits and long running workflow that uses 10 credits per run; it's possible that two concurrent events trigger the workflow, and the cap will won't apply until after the concurrent events are processed.
</Callout>
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Improve Grammar and Clarity in the Callout Content
The callout on lines 35–39 contains a sentence with grammatical issues that may confuse readers. In particular, line 38 has a double modal ("will won't") and omits necessary articles. Below is a suggested revision to improve clarity and grammatical correctness:

- In an example scenario, with cap set at 20 credits and long running workflow that uses 10 credits per run; it's possible that two concurrent events trigger the workflow, and the cap will won't apply until after the concurrent events are processed.
+ In an example scenario, with a cap set at 20 credits and a long-running workflow that uses 10 credits per run, it's possible that two concurrent events trigger the workflow, and the cap won't apply until after the concurrent events are processed.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
<Callout type="info">
Due to how credits are accrued, there may be cases where your credit usage may _slightly_ go over the cap.
In an example scenario, with cap set at 20 credits and long running workflow that uses 10 credits per run; it's possible that two concurrent events trigger the workflow, and the cap will won't apply until after the concurrent events are processed.
</Callout>
<Callout type="info">
Due to how credits are accrued, there may be cases where your credit usage may _slightly_ go over the cap.
In an example scenario, with a cap set at 20 credits and a long-running workflow that uses 10 credits per run, it's possible that two concurrent events trigger the workflow, and the cap won't apply until after the concurrent events are processed.
</Callout>
🧰 Tools
🪛 LanguageTool

[uncategorized] ~38-~38: You might be missing the article “a” here.
Context: ... the cap. In an example scenario, with cap set at 20 credits and long running work...

(AI_EN_LECTOR_MISSING_DETERMINER_A)


[misspelling] ~38-~38: This word is normally spelled with a hyphen.
Context: ...cenario, with cap set at 20 credits and long running workflow that uses 10 credits per run; ...

(EN_COMPOUNDS_LONG_RUNNING)


[style] ~38-~38: For conciseness, try rephrasing this sentence.
Context: ... workflow that uses 10 credits per run; it's possible that two concurrent events trigger the workflow, and the cap will won't ap...

(MAY_MIGHT_BE)


## Limits

For users on the [Free tier](/pricing/#free-tier), this section displays your usage towards your [credits quota](/workflows/limits/#daily-credits-limit) for the current UTC day.
Original file line number Diff line number Diff line change
@@ -1,27 +1,23 @@
import Callout from '@/components/Callout'
import VideoPlayer from '@/components/VideoPlayer'

# User and Billing Settings
# User Settings

You can find important account details, text editor configuration, and more in your [User Settings](https://pipedream.com/user).

## Account

You'll find your Pipedream email and other basic account details in your [Account Settings](https://pipedream.com/user).

### Changing your email
## Changing your email

Pipedream sends system emails to the email address tied to your Pipedream login. You can change the email address to which these emails are delivered by modifying the **Email** in your Account Settings. Once changed, an email will be delivered to the new address requesting you verify it.

Pipedream marketing emails may still be sent to the original email address you used when signing up for Pipedream. To change the email address tied to marketing emails, please [reach out to our team](https://pipedream.com/support).

### Two-Factor Authentication
## Two-Factor Authentication

<VideoPlayer src="https://www.youtube.com/embed/M2_JrDh6cVI?si=1Yee9XJ10PhzoMmJ" title="Two Factor Authenitcation" />

Two-factor authentication (2FA) adds an additional layer of security for your Pipedream account and is recommended for all users.

#### Configuring 2FA
### Configuring 2FA

1. Open your [Account Settings](https://pipedream.com/user)
2. Click **Configure** under **Two-Factor Authentication**
Expand All @@ -36,7 +32,7 @@ Save your recovery codes
If you lose access to your authenticator app and your recovery codes, you will permanently lose access to your Pipedream account. **Pipedream Support cannot recover these accounts.**
</Callout>

#### Signing in with 2FA
### Signing in with 2FA

1. You'll be prompted to enter your OTP the next time you sign in to Pipedream
2. When prompted, you can enter the OTP from your authenticator app or a recovery code
Expand All @@ -52,9 +48,9 @@ Each recovery code is a one-time-use code, so make sure to generate new recovery
Pipedream recommends enabling 2FA with your identity provider.
</Callout>

#### Requiring 2-Factor Authentication
### Requiring 2-Factor Authentication

Workspaces on the Business plan can [require all workspace members to configure 2FA](/workspaces/#requiring-two-factor-authentication) in order to log in to Pipedream.
Workspaces on the Business plan can [require all workspace members to configure 2FA](/workflows/workspaces/#requiring-two-factor-authentication) in order to log in to Pipedream.

If you are a member of any workspace where 2FA is required, you cannot disable 2FA, but you can still reconfigure it in your [account settings](https://pipedream.com/account/) if necessary.

Expand All @@ -64,13 +60,13 @@ Admins and Owners control 2FA settings
Only workspace owner and admin members can enable or disable 2FA for an entire workspace.
</Callout>

### Pipedream API Key
## Pipedream API Key

Pipedream provides a [REST API](/api/) for interacting with Pipedream programmatically. You'll find your API key here, which you use to [authorize requests to the API](/rest-api/auth/).
Pipedream provides a [REST API](/api/) for interacting with Pipedream programmatically. You'll find your API key here, which you use to [authorize requests to the API](/workflows/rest-api/auth/).

You can revoke and regenerate your API key from here at any time.

### Delete Account
## Delete Account

You can delete your Pipedream account at any time by visiting your Account Settings and pressing the **Delete your Account** button. Account deletion is immediately and irreversible.

Expand All @@ -87,45 +83,3 @@ For example, you can:
## Environment Variables

Environment variables allow you to securely store secrets or other config values that you can access in Pipedream workflows via `process.env`. [Read more about environment variables here](/environment-variables/).

## Billing and Usage

You'll find information on your usage data (for specific [Pipedream limits](/limits/)) in your [Billing Settings](https://pipedream.com/settings/billing). You can also upgrade to [paid plans](https://pipedream.com/pricing) from this page.

### Subscription

You can upgrade to [paid plans](https://pipedream.com/pricing) from this section.

If you've already upgraded, you'll see an option to **Manage Subscription** here, which directs you to your personal Stripe portal. Here, you can change your payment method, review the details of previous invoices, and more.

### Usage

[Credits](/pricing/#credits) are Pipedream's billable unit, and users on the [free tier](/pricing/#free-tier) are limited on the number of daily free credits allocated. The **Usage** section displays a chart of the daily credits across a historical range of time to provide insight into your usage patterns.

Hover over a specific column in the chart to see the number of credits run for that specific day:

![Daily credits tooltip](./images/daily-invocations-tooltip.png)

_Click_ on a specific column to see credits for that day, broken out by workflow / source:

![Credits broken out by workflow / source](./images/usage-by-resource.png)

Users on the free tier will see the last 30 days of usage in this chart. Users on [paid plans](https://pipedream.com/pricing) will see the cumulative usage tied to their current billing period.

### Compute Budget

Control the maximum number of compute credits permitted on your account with an _Credit Budget_.

This will restrict your account-wide usage to the specified number of [credits](/pricing/#credits) on a monthly or daily basis. The compute budget does not apply to credits incurred by [dedicated workers](/workflows/settings/#eliminate-cold-starts).

To enable this feature, _click_ on the toggle and define your maximum number of credits in the period.

<Callout type="info">
Due to how credits are accrued, there may be cases where your credit usage may _slightly_ go over the cap.

In an example scenario, with cap set at 20 credits and long running workflow that uses 10 credits per run; it's possible that two concurrent events trigger the workflow, and the cap will won't apply until after the concurrent events are processed.
</Callout>

### Limits

For users on the [Free tier](/pricing/#free-tier), this section displays your usage towards your [credits quota](/limits/#daily-credits-limit) for the current UTC day.
6 changes: 0 additions & 6 deletions docs-v2/pages/api/_meta.tsx

This file was deleted.

5 changes: 0 additions & 5 deletions docs-v2/pages/apps/_meta.tsx

This file was deleted.

Loading
Loading