Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
4 changes: 4 additions & 0 deletions docs-v2/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,7 @@ yarn-error.log*
# typescript
*.tsbuildinfo
next-env.d.ts

# sitemap
/public/sitemap*.xml
/public/robots.txt
33 changes: 33 additions & 0 deletions docs-v2/next-sitemap.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
/** @type {import('next-sitemap').IConfig} */
module.exports = {
siteUrl: "https://pipedream.com/docs",
generateRobotsTxt: true,
outDir: "public",
changefreq: "daily",
priority: 0.7,
generateIndexSitemap: false,
exclude: [
"/hidden/*",
"/deprecated/*",
],
transform: async (config, path) => {
// Add any custom transformations for URL paths here if needed in the future
return {
loc: path,
changefreq: config.changefreq,
priority: config.priority,
lastmod: config.autoLastmod
? new Date().toISOString()
: undefined,
alternateRefs: config.alternateRefs ?? [],
};
},
robotsTxtOptions: {
policies: [
{
userAgent: "*",
allow: "/",
},
],
},
};
40 changes: 40 additions & 0 deletions docs-v2/next.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,46 @@ export default withNextra({
destination: "/integrations/oauth-clients/",
permanent: true,
},
{
source: "/integrations/:path*/",
destination: "/apps/:path*/",
permanent: true,
},
{
source: "/workflows/contributing/components/:path*/",
destination: "/components/contributing/:path*/",
permanent: true,
},
{
source: "/workflows/contributing/components/",
destination: "/components/contributing/",
permanent: true,
},
{
source: "/workflows/contributing/",
destination: "/components/contributing/",
permanent: true,
},
{
source: "/workflows/projects/:path*/",
destination: "/projects/:path*/",
permanent: true,
},
{
source: "/workflows/projects/",
destination: "/projects/",
permanent: true,
},
{
source: "/workflows/workspaces/:path*/",
destination: "/workspaces/:path*/",
permanent: true,
},
{
source: "/workflows/workspaces/",
destination: "/workspaces/",
permanent: true,
},
];
},
async rewrites() {
Expand Down
49 changes: 49 additions & 0 deletions docs-v2/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions docs-v2/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
"scripts": {
"dev": "next dev",
"build": "next build",
"postbuild": "next-sitemap",
"start": "next start"
},
"packageManager": "[email protected]",
Expand Down Expand Up @@ -33,6 +34,7 @@
"devDependencies": {
"@types/node": "18.11.10",
"autoprefixer": "^10.4.19",
"next-sitemap": "^4.2.3",
"postcss": "^8.4.40",
"prettier": "^3.3.3",
"tailwindcss": "^3.4.7",
Expand Down
7 changes: 5 additions & 2 deletions docs-v2/pages/_meta.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
export default {
"index": "What is Pipedream?",
"quickstart": "Quickstart",
"integrations": "Integrations",
"workflows": "Workflows",
"workspaces": "Workspaces",
"projects": "Projects",
"connect": "Connect",
"workflows": "Workflows",
"apps": "Apps",
"components": "Components",
"rest-api": "REST API",
"pricing": "Pricing",
"account": "Account",
Expand Down
2 changes: 1 addition & 1 deletion docs-v2/pages/account/user-settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Pipedream recommends enabling 2FA with your identity provider.

### Requiring 2-Factor Authentication

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.
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.

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 Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ export default {
"apps": "Integrated Apps",
"connected-accounts": "Connected Accounts",
"oauth-clients": "OAuth Clients",
"external-auth": "External Auth",
"external-auth": {
display: "hidden",
},
"app-partners": "App Partners",
} as const
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Pipedream has built-in integrations with more than {process.env.PUBLIC_APPS} app

But Pipedream-integrated apps provide a few benefits:

- You can [connect the app once](/integrations/connected-accounts/) and [link that connected account to any step of a workflow](/integrations/connected-accounts/#connecting-accounts)
- Pipedream provides [pre-built actions](/workflows/contributing/components/#actions) that wrap common operations for the app. You shouldn't have to write the code to send a message to Slack, or add a new row to a Google Sheet, so actions make that easy. Actions are just code, so you can fork and modify them, or even [publish your own to the Pipedream community](/workflows/contributing/).
- You can [connect the app once](/apps/connected-accounts/) and [link that connected account to any step of a workflow](/apps/connected-accounts/#connecting-accounts)
- Pipedream provides [pre-built actions](/components/contributing/#actions) that wrap common operations for the app. You shouldn't have to write the code to send a message to Slack, or add a new row to a Google Sheet, so actions make that easy. Actions are just code, so you can fork and modify them, or even [publish your own to the Pipedream community](/components/contributing/).
- [You have access to your API keys and access tokens in code steps](/workflows/building-workflows/code/nodejs/auth/), so you can write any code to authorize custom requests to these apps.

## Premium Apps
Expand Down Expand Up @@ -73,7 +73,7 @@ The vast majority of integrated apps on Pipedream are free to use in your workfl

<Callout type="info">
Missing an integration?
If we don't have an integration for an app that you'd like to see, please [let us know](https://pipedream.com/support) or [contribute it to the source available Pipedream registry](/workflows/contributing/).
If we don't have an integration for an app that you'd like to see, please [let us know](https://pipedream.com/support) or [contribute it to the source available Pipedream registry](/components/contributing/).
</Callout>

**Check out the full list of integrated apps [here](https://pipedream.com/apps).**
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Pipedream provides native integrations for [{process.env.PUBLIC_APPS}+ APIs](htt

Pipedream handles OAuth for you, ensuring you always have a fresh access token to authorize requests, and [credentials are tightly-secured](/privacy-and-security/#third-party-oauth-grants-api-keys-and-environment-variables).

If you use an existing secrets store, or manage credentials in a database, you can also [pass those to Pipedream at runtime](/integrations/connected-accounts/external-auth/) instead of connecting accounts in the UI.
If you use an existing secrets store, or manage credentials in a database, you can also [pass those to Pipedream at runtime](/apps/connected-accounts/external-auth/) instead of connecting accounts in the UI.

## Supported Apps

Expand Down Expand Up @@ -236,7 +236,7 @@ You can access credentials for any connected account via API, letting you build

## Passing external credentials at runtime

If you use a secrets store like [Pipedream Connect](/connect/) or [HashiCorp Vault](https://www.vaultproject.io/), or if you store credentials in a database, you can retrieve these secrets at runtime and pass them to any step. [See the full guide here](/integrations/connected-accounts/external-auth/).
If you use a secrets store like [Pipedream Connect](/connect/) or [HashiCorp Vault](https://www.vaultproject.io/), or if you store credentials in a database, you can retrieve these secrets at runtime and pass them to any step. [See the full guide here](/apps/connected-accounts/external-auth/).

## Connecting to apps with IP restrictions

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export default {
"index": "Overview",
"components": "Components",
"contributing": "Contributing",
} as const
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import Callout from '@/components/Callout'

## Overview

This document is intended for developers who want to author and edit [Pipedream Actions](/workflows/contributing/components/#actions). After completing this quickstart, you'll understand how to:
This document is intended for developers who want to author and edit [Pipedream Actions](/components/contributing/#actions). After completing this quickstart, you'll understand how to:

- Develop Pipedream components
- Publish private actions and use them in workflows
Expand All @@ -16,7 +16,7 @@ This document is intended for developers who want to author and edit [Pipedream
- Use Pipedream managed auth for a 3rd party app

<Callout type="info">
If you previously developed actions using Pipedream's UI, we recommend reviewing our [migration guide](/workflows/contributing/components/migrating/) after completing this quickstart.
If you previously developed actions using Pipedream's UI, we recommend reviewing our [migration guide](/components/contributing/migrating/) after completing this quickstart.
</Callout>

## Prerequisites
Expand Down Expand Up @@ -57,7 +57,7 @@ We recommend that you complete the examples below in order.

### hello world!

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

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

### hello [name]!

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

```java
export default {
Expand Down Expand Up @@ -340,7 +340,7 @@ export default {
};
```

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

```javascript
import { Octokit } from "@octokit/rest";
Expand Down Expand Up @@ -397,7 +397,7 @@ export default {
};
```

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

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

## What's Next?

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

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