Skip to content

Commit 2f90de3

Browse files
authored
Docs on manually triggering builds and previews (#784)
* Update preview deployment info * add images * 💅 * add deployments page * add images * update images * add reviewer feedback * polish
1 parent 3f8f1ea commit 2f90de3

9 files changed

+66
-8
lines changed

docs.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@
140140

141141
]
142142
},
143+
"guides/deployments",
143144
"contact-support"
144145
]
145146
},

guides/deployments.mdx

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Deployments"
3+
description: "Troubleshoot your deployments"
4+
icon: "boxes"
5+
---
6+
7+
Your documentation site automatically deploys when you push changes to your connected repository. This requires the Mintlify GitHub app to be properly installed and connected.
8+
9+
If your latest changes are not appearing on your live site, first check that the GitHub app is installed on the account or organization that owns your docs repository. See [GitHub troubleshooting](/settings/github#troubleshooting) for more information.
10+
11+
If the GitHub app is connected, but changes are still not deploying, you can manually trigger a rebuild from your dashboard.
12+
13+
## Manually triggering a deployment
14+
15+
<Steps>
16+
<Step title="Verify your latest commit was successful.">
17+
Check that your latest commit appears in your docs repository and did not encounter any errors.
18+
</Step>
19+
<Step title="Manually trigger a deployment.">
20+
Go to your [dashboard](https://dashboard.mintlify.com) and select the deploy button.
21+
<Frame>
22+
<img src="/images/deployments/manual-update-light.png" alt="The manual update button emphasized with an orange rectangle." className="block dark:hidden" />
23+
<img src="/images/deployments/manual-update-dark.png" alt="The manual update button emphasized with an orange rectangle." className="hidden dark:block" />
24+
</Frame>
25+
</Step>
26+
</Steps>
30.9 KB
Loading
31.3 KB
Loading
30.2 KB
Loading
30.8 KB
Loading
120 KB
Loading
120 KB
Loading

settings/preview-deployments.mdx

Lines changed: 39 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,51 @@ icon: "scan-eye"
55
---
66

77
<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{" "}
99
<a href="mailto:[email protected]">contact sales</a> for more information.
1010
</Info>
1111

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

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
1515

16-
## Sharing Preview Deployments
16+
Preview deployments are created automatically through pull requests or manually from your dashboard.
1717

18-
After generating a preview URL, you can share that link with anybody for them to view.
18+
### Automatic previews
1919

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

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+
<img src="/images/previews/preview-deployment-light.png" alt="Link to view deployment in the pull request timeline" className="block dark:hidden" />
24+
<img src="/images/previews/preview-deployment-dark.png" alt="Link to view deployment in the pull request timeline" className="hidden dark:block" />
25+
</Frame>
2326

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 if you are on a Growth or Enterprise plan or have the preview deployment add-on.
30+
31+
1. Go to your [dashboard](https://dashboard.mintlify.com/).
32+
2. Select **Previews**.
33+
3. Select **Create preview**.
34+
4. Enter your branch name.
35+
5. Select **Create deployment**.
36+
37+
## Redeploying a preview
38+
39+
Redeploy a preview to refresh content or retry after a failed deployment.
40+
41+
1. Select the preview from your [dashboard](https://dashboard.mintlify.com/).
42+
2. Select **Redeploy**.
43+
44+
<Frame>
45+
<img src="/images/previews/redeploy-preview-light.png" alt="The Previews menu with the deploy button emphasized by an orange rectangle." className="block dark:hidden" />
46+
<img src="/images/previews/redeploy-preview-dark.png" alt="The Previews menu with the deploy button emphasized by an orange rectangle." className="hidden dark:block" />
47+
</Frame>
48+
49+
## Sharing preview deployments
50+
51+
Preview deployments can be publicly accessible or restricted to authenticated users.
52+
53+
**Public access**: Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes.
54+
55+
**Restricted access**: Enable preview 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

Comments
 (0)