Skip to content

Commit 6b76304

Browse files
fix docs
1 parent 71820e3 commit 6b76304

File tree

1 file changed

+16
-20
lines changed

1 file changed

+16
-20
lines changed

docs-v2/pages/quickstart/github-sync.mdx

Lines changed: 16 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ import { Steps } from 'nextra/components'
33

44
# Quickstart - Github Sync
55

6-
The purpose of this guide is to help you start building projects on Pipedream using **GitHub Sync**.
6+
The purpose of this guide is to help you start building projects on Pipedream using **GitHub Sync**.
77

88
This guide assumes you:
99

10-
- Have a Pipedream account
10+
- Have a Pipedream account
1111
- Have a GitHub account
1212
- Understand the basics of workflow development on Pipedream
1313
- Are familiar with git-concepts (branches, commits, merges, etc)
@@ -17,10 +17,6 @@ This guide assumes you:
1717
If you are new to Pipedream, we recommend starting with the [basics of workflow development](/quickstart/).
1818
</Callout>
1919

20-
<Callout type="info">
21-
Users on the Free and Basic plan may preview GitHub Sync by enabling the feature **when creating a new project.** You will not be able to merge to production without upgrading. When you upgrade, you may enable or disable GitHub sync for projects at any time.
22-
</Callout>
23-
2420
<Steps>
2521
### Create a new project
2622

@@ -34,7 +30,7 @@ Visit [https://pipedream.com/projects](https://pipedream.com/projects) and click
3430

3531
![github](./images/create_project.png)
3632

37-
Enter a project name or click the icon to generate a random name and check the box to **Configure GitHub Sync**.
33+
Enter a project name or click the icon to generate a random name and check the box to **Configure GitHub Sync**.
3834

3935
![github](./images/configure_project_1.png)
4036

@@ -45,11 +41,11 @@ Select or connect a GitHub account, username and repo name and click **Create Pr
4541

4642
### Create a branch to make edits
4743

48-
Once your project is ready, click on the **Edit** button.
44+
Once your project is ready, click on the **Edit** button.
4945

5046
![github](./images/edit_1.png)
5147

52-
Since this is a new project, you will prompted to create a branch. You may accept the default branch name or customize it.
48+
Since this is a new project, you will prompted to create a branch. You may accept the default branch name or customize it.
5349

5450
![github](./images/edit_2.png)
5551

@@ -69,12 +65,12 @@ For this example, name the workflow and click **Create Workflow** to use the def
6965

7066
![github](./images/configure_workflow.png)
7167

72-
Build a simple workflow with an HTTP trigger and Node code step.
68+
Build a simple workflow with an HTTP trigger and Node code step.
7369

7470
![github](./images/github-sync-v3/sample-workflow.png)
7571

7672

77-
At this point, your workflow is saved, but changes have not been commited to GitHub. To do that, click on the dropdown menu and select **Commit**.
73+
At this point, your workflow is saved, but changes have not been commited to GitHub. To do that, click on the dropdown menu and select **Commit**.
7874

7975
![github](./images/github-sync-v3/commit-changes.png)
8076

@@ -88,11 +84,11 @@ Next, make an edit to the code (e.g., add a comment). Commit your changes again.
8884

8985
### View your project on GitHub
9086

91-
Open the Git actions menu and select **View branch on GitHub**.
87+
Open the Git actions menu and select **View branch on GitHub**.
9288

9389
![github](./images/github-sync-v3/view-branch.png)
9490

95-
You can explore the files created, including the YAML file with the workflow definition and the javascript file with the code for the Node step.
91+
You can explore the files created, including the YAML file with the workflow definition and the javascript file with the code for the Node step.
9692

9793
![github](./images/view_branch_on_github_2.png)
9894

@@ -102,7 +98,7 @@ Optionally navigate to the file with the code step and make an edit to the file
10298

10399
### Merge your changes to production
104100

105-
Merge to production to deploy the workflow to Pipedream.
101+
Merge to production to deploy the workflow to Pipedream.
106102

107103
![github](./images/github-sync-v3/merge-to-prod.png)
108104

@@ -118,27 +114,27 @@ To edit a previously merged branch, you may create a new branch or click **Edit*
118114

119115
![github](./images/edit_production.png)
120116

121-
Open the workflow in Pipedream's editor and add an HTTP request action to the end of the workflow. Configure the action to `GET` the URL `https://example.com`.
117+
Open the workflow in Pipedream's editor and add an HTTP request action to the end of the workflow. Configure the action to `GET` the URL `https://example.com`.
122118

123119
![github](./images/github-sync-v3/merge-to-prod-2.png)
124120

125-
This time, we'll merge directly to production without commiting separately. Click **Merge to Production** to view the diff, commit and merge.
121+
This time, we'll merge directly to production without commiting separately. Click **Merge to Production** to view the diff, commit and merge.
126122

127123
![github](./images/github-sync-v3/commit-diff-2.png)
128124

129125
You may also view the repo on GitHub to see how the action configuration is represented in the YAML of the workflow definition. Try other actions, including actions that use connected accounts and explore how they're represented in the GitHub code.
130126

131-
### Make an edit and merge from GitHub
127+
### Make an edit and merge from GitHub
132128

133-
As the final step of this quickstart, view the repository on GitHub and navigate to the code step. Click the edit icon and made a simple change (e.g., add a comment).
129+
As the final step of this quickstart, view the repository on GitHub and navigate to the code step. Click the edit icon and made a simple change (e.g., add a comment).
134130

135131
![github](./images/edit_in_github.png)
136132

137-
Commit and create a PR.
133+
Commit and create a PR.
138134

139135
![github](./images/create_pr.png)
140136

141-
Then open the PR, review the changes and merge.
137+
Then open the PR, review the changes and merge.
142138

143139
![github](./images/merge_pr.png)
144140

0 commit comments

Comments
 (0)