You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: settings/preview-deployments.mdx
+45-8Lines changed: 45 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,20 +5,57 @@ icon: "scan-eye"
5
5
---
6
6
7
7
<Info>
8
-
Preview Deployments are available on the[Growth and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). Please{""}
8
+
Preview deployments are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). Please{""}
9
9
<ahref="mailto:[email protected]">contact sales</a> for more information.
10
10
</Info>
11
11
12
-
Preview Deployments allow you to preview changes to your docs in a live deployment without merging those changes to your production branch.
12
+
Preview deployments let you see how changes to your docs will look before merging to production. Each preview creates a shareable URL that updates automatically as you push new changes.
13
13
14
-
If you have created a pull or merge request when using Git, the generated preview URL will be available as a comment from the Mintlify bot in the PR. This URL will always reflect the latest deployment changes.
14
+
## Creating preview deployments
15
15
16
-
## Sharing Preview Deployments
16
+
Preview deployments are created automatically through pull requests or manually from your dashboard.
17
17
18
-
After generating a preview URL, you can share that link with anybody for them to view.
18
+
### Automatic previews
19
19
20
-
### Authenticated Preview Deployments
20
+
When you create a pull request, the Mintlify bot automatically adds a link to view the preview deployment in your pull request. The preview updates each time you push new commits to the branch.
21
21
22
-
If you'd like to restrict access to your Preview Deployments, you can set up preview deployment authentication. When using this authentication method, only Mintlify authenticated users will be able to access your Preview Deployments.
22
+
<Frame>
23
+
<imgsrc="/images/previews/preview-deployment-light.png"alt="Link to view deployment in the pull request timeline"className="block dark:hidden" />
24
+
<imgsrc="/images/previews/preview-deployment-dark.png"alt="Link to view deployment in the pull request timeline"className="hidden dark:block" />
25
+
</Frame>
23
26
24
-
To set up preview deployment authentication, please [contact sales](mailto:[email protected]).
27
+
### Manual previews
28
+
29
+
You can manually create a preview for any branch.
30
+
31
+
<Steps>
32
+
<Steptitle="Navigate to previews.">
33
+
1. Go to your [dashboard](https://dashboard.mintlify.com/)
34
+
2. Select **Previews**.
35
+
</Step>
36
+
<Steptitle="Create preview.">
37
+
1. Select **Create preview**.
38
+
2. Enter your branch name.
39
+
3. Select **Create deployment**.
40
+
</Step>
41
+
</Steps>
42
+
43
+
## Redeploying a preview
44
+
45
+
Redeploy a preview to refresh content or retry after a failed deployment.
46
+
47
+
1. Select the preview from your dashboard.
48
+
2. Select **Redeploy**.
49
+
50
+
<Frame>
51
+
<imgsrc="/images/previews/redeploy-preview-light.png"alt="The Previews menu with the deploy button emphasized by an orange rectangle."className="block dark:hidden" />
52
+
<imgsrc="/images/previews/redeploy-preview-dark.png"alt="The Previews menu with the deploy button emphasized by an orange rectangle."className="hidden dark:block" />
53
+
</Frame>
54
+
55
+
## Sharing preview deployments
56
+
57
+
Preview deployments can be publicly accessible or restricted to authenticated users.
58
+
59
+
**Public access**: Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes.
60
+
61
+
**Restricted access**: Enable deployment authentication to limit preview access to authenticated Mintlify users only. [Contact sales](mailto:[email protected]) to set up authentication for your previews.
0 commit comments