Skip to content

Commit d14a93e

Browse files
committed
docs: update quickstart
1 parent cc9de4d commit d14a93e

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed
119 KB
Loading

docs/quickstart.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,17 @@ With your account ready, move on to creating your first integration.
2121

2222
To create a new integration, follow these steps:
2323

24-
1. In the PushPreview dashboard, go to the **Integrations** tab.
24+
In your PushFeedback dashboard, click the **Integrations** tab in the top navbar.
25+
2526
2. Click the **Create integration** button.
27+
28+
![Preview changes](./images/pushpreview-integration.png)
29+
2630
3. Complete the setup wizard:
2731

28-
1. **Add the GitHub workflow to your repository:** Add the pushpreview.yml workflow to your repository. This workflow responds to pull requests and comments, triggering previews.
29-
2. **Configure the Github secret:** Add the `PUSHPREVIEW_TOKEN` secret in your repository's or organization's GitHub settings to authenticate requests.
30-
3. **Trigger the preview**: Add the tag `preview` to your pull requests to initiate the preview generation process. The preview tag can be selected from existing tags or created anew if it doesn't exist.
32+
1. **Add the GitHub workflow to your repository:** Add the `pushpreview.yml` workflow under the `.github/workflow` directory of your repository.
33+
2. **Configure the GitHub secret:** Add the `PUSHPREVIEW_TOKEN` secret returned by the wizard within your repository's or organization's [GitHub settings](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository).
34+
3. **Trigger the preview**: Add the `preview` label to your pull requests to initiate the preview generation process. If the label doesn’t exist, [create a new one](https://docs.github.com/en/issues/using-labels-and-milestones-to-track-work/managing-labels#creating-a-label).
3135

3236
:::info
3337
If you encounter any issues, refer to the [Installation](category/installation) section for CMS-specific guides.

0 commit comments

Comments
 (0)