Skip to content

Commit 9decc02

Browse files
docs for publishing templates to the gallery (#13882)
1 parent 386b64c commit 9decc02

File tree

4 files changed

+56
-20
lines changed

4 files changed

+56
-20
lines changed

docs-v2/pages/workflows/_meta.json

+3
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,8 @@
1515
"sharing": "Sharing workflows",
1616
"build-and-run": {
1717
"display": "hidden"
18+
},
19+
"switch-to-v2": {
20+
"display": "hidden"
1821
}
1922
}
Loading
Loading

docs-v2/pages/workflows/sharing.mdx

+53-20
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
import { Cards, Card } from 'nextra/components'
1+
import { Cards, Card, Steps } from 'nextra/components'
22
import Callout from '@/components/Callout'
33
import RocketShip from '@/components/RocketShip'
4+
import Image from 'next/image'
45

56
# Sharing Workflows
67

8+
Pipedream provides a few ways to share your workflow:
9+
1. [Share a workflow as a link with anyone](#creating-a-share-link-for-a-workflow)
10+
2. [Publish as a public template](#publish-to-the-templates-gallery)
11+
712
You can share your workflows as templates with other Pipedream accounts with a unique shareable link.
813

914
Creating a share link for your workflow will allow anyone with the link to create a template version of your workflow in their own Pipedream account. This will allow others to use your workflow with their own Pipedream account and also their own connected accounts.
@@ -22,43 +27,75 @@ The copied workflow includes the same trigger, steps, and connected account conf
2227

2328
## Creating a share link for a workflow
2429

25-
To share a workflow, open the **Builder** for the workflow. Then in the top right menu, select **Create Share Link**.
30+
To share a workflow, open the workflow in your browser. Then in the top right menu, select **Create Share Link**.
2631

27-
![Click "Create Share Link" in the workflow's settings within the builder to generate a sharable link](pages/workflows/images/sharing/sharing-workflow-button.png)
32+
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1725925756/create-share-link_ekm2gy.png" alt="Click Create Share Link" width={500} height={529} />
2833

2934
Now you can define which prop values should be included in this shareable link.
3035

31-
## Including props
36+
### Including props
3237

3338
Optionally, you can include the actual individual prop configurations as well. This helps speed up workflow development if the workflow relies on specific prop values to function properly.
3439

3540
You can choose to **Include all** prop values if you'd like, or only select specific props.
3641

3742
For the daily schedule reminder workflow, we included the props for filtering Google Calendar events, but we did _not_ include the SMS number to send the message to. This is because the end user of this workflow will use their own phone number instead:
3843

39-
![Sharing a workflow that will send a daily SMS message of your Google Calendar schedule for today](https://res.cloudinary.com/pipedreamin/image/upload/v1685113542/docs/docs/share%20workflows/CleanShot_2023-05-26_at_11.05.16_hebqpl.png)
44+
<br />
45+
46+
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1725926251/create-share-link-configure_qn4z60.png" alt="Sharing a workflow that will send a daily SMS message of your Google Calendar schedule for today" width={500} height={529} />
4047

4148
<Callout type="info">
42-
Connected Accounts are not shared
49+
**Your connected accounts are not shared.** When other users configure your workflow from the shared link they'll be prompted to connect their own accounts.
50+
</Callout>
51+
52+
### Versioning
53+
54+
- When you create a shared link for your workflow, that link is frozen to the version of your workflow at the time the link was created
55+
- If you make changes to the original workflow, those changes will _not_ be included in the shared workflow link, nor in any workflows copied from the original shared link
56+
- To push out new changes to a workflow, you'll need to generate a new share link
4357

44-
Shared workflow links do not include your own connected accounts. Instead, in this new workflow, the user of your workflow link is prompted to connect their own accounts.
58+
<Callout type="info">
59+
**Share links persist**. You can create multiple share links for the same workflow with different prop configurations, or even different steps. Share links do not expire, nor do newly created link overwrite existing ones.
4560
</Callout>
4661

47-
## Versioning
62+
## Publish to the templates gallery
4863

49-
When you create a shared link for your workflow, that link is frozen to the version of your workflow at the time the link was created.
64+
We're excited to highlight the various use cases our community and partners have enabled using Pipedream. To do this, we've created a [Templates Gallery](https://pipedream.com/templates/) with a growing number of high-quality templates to help you discover your next workflow.
5065

51-
If changes are made to the original workflow, the changes will _not_ be included in the shared workflow link, nor in any workflows copied from the original shared link.
66+
The process to publish your own workflow to the Templates Gallery is similar to [creating a share link](#creating-a-share-link-for-a-workflow):
5267

53-
[Generate a new share link](#creating-a-share-link-for-a-workflow) to include new changes to a workflow.
68+
<Steps>
5469

55-
<Callout type="info">
56-
**Share links persist**
70+
### Open the workflow you'd like to share
5771

58-
You can create multiple share links for the same workflow with different prop configurations, or even different steps.
72+
To get started, open the workflow in your browser. Then in the top right menu, select **Publish as a template**.
5973

60-
Share links will not expire or be overridden.
61-
</Callout>
74+
<br />
75+
76+
<Image src="https://res.cloudinary.com/pipedreamin/image/upload/v1725925756/publish-as-template_tbetej.png" alt="Click Publish as a template" width={500} height={529} />
77+
78+
### Configure which prop values to include in the template
79+
80+
Follow the same steps as above to select the prop input values you'd like to include in the template, then click **Continue**
81+
82+
### Enter the required information for the template title, description, and tags
83+
84+
On the next screen, you'll be prompted for additional information about your template:
85+
86+
- **Developer name**: This is probably you — this name will be displayed as the author of the template.
87+
- **Template name**: The name of the template.
88+
- **Brief description**: A short description of the template, which will be displayed on the listing page (maximum 256 characters). [See here](https://pipedream.com/templates) for examples.
89+
- **Longer description**: Use Markdown to create a more in-depth description. We recommend including distinct sections as H2s, for you to provide an **Overview**, **Steps**, and **Use Cases**. This will be displayed on the details page for the template. Here's an example: [Notion Voice Notes (Google Drive)](https://pipedream.com/templates/notion-voice-notes-google-drive-mpt_VdXF5V).
90+
- **Use cases**: Select one or more categories that align with the use cases for your template to help users discover it.
91+
- **Affiliate token**: If you're a [Pipedream affiliate](https://pipedream.com/affiliates), you can enter your unique token here to earn commissions on any users who # for Pipedream after using your template.
92+
93+
### Click **Submit**
94+
95+
- Once you've filled out the required information, click **Submit**.
96+
- We'll review your template and will email you once it goes live!
97+
98+
</Steps>
6299

63100
## Frequently Asked Questions
64101

@@ -102,10 +139,6 @@ It's only possible to share a single workflow at time with a link at this time.
102139

103140
If you're trying to migrate all resources from one workspace to another [please contact us for help](mailto:support@pipedream.com).
104141

105-
### Can I share my v1 workflows?
106-
107-
No, v1 workflows are not shareable. If you need to share a v1 workflow, please see our [migration guide](/migrate-from-v1/) to convert it into a modern v2 workflow.
108-
109142
### Are step notes included when I share a workflow?
110143

111144
Yes any [step notes](/workflows/steps/#step-notes) you've added to your workflow are included in the copied version.

0 commit comments

Comments
 (0)