diff --git a/docs.json b/docs.json index af1b1ab54..2917214ab 100644 --- a/docs.json +++ b/docs.json @@ -139,6 +139,7 @@ ] }, + "guides/deployments", "contact-support" ] }, diff --git a/guides/deployments.mdx b/guides/deployments.mdx new file mode 100644 index 000000000..cf382d724 --- /dev/null +++ b/guides/deployments.mdx @@ -0,0 +1,26 @@ +--- +title: "Deployments" +description: "Troubleshoot your deployments" +icon: "boxes" +--- + +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. + +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. + +If the GitHub app is connected, but changes are still not deploying, you can manually trigger a rebuild from your dashboard. + +## Manually triggering a deployment + + + + Check that your latest commit appears in your docs repository and did not encounter any errors. + + + Go to your [dashboard](https://dashboard.mintlify.com) and select the deploy button. + + The manual update button emphasized with an orange rectangle. + The manual update button emphasized with an orange rectangle. + + + diff --git a/images/deployments/manual-update-dark.png b/images/deployments/manual-update-dark.png new file mode 100644 index 000000000..afb19f123 Binary files /dev/null and b/images/deployments/manual-update-dark.png differ diff --git a/images/deployments/manual-update-light.png b/images/deployments/manual-update-light.png new file mode 100644 index 000000000..7a3d7f3f5 Binary files /dev/null and b/images/deployments/manual-update-light.png differ diff --git a/images/previews/preview-deployment-dark.png b/images/previews/preview-deployment-dark.png new file mode 100644 index 000000000..cd4f8c478 Binary files /dev/null and b/images/previews/preview-deployment-dark.png differ diff --git a/images/previews/preview-deployment-light.png b/images/previews/preview-deployment-light.png new file mode 100644 index 000000000..41dabec12 Binary files /dev/null and b/images/previews/preview-deployment-light.png differ diff --git a/images/previews/redeploy-preview-dark.png b/images/previews/redeploy-preview-dark.png new file mode 100644 index 000000000..1061b0d2e Binary files /dev/null and b/images/previews/redeploy-preview-dark.png differ diff --git a/images/previews/redeploy-preview-light.png b/images/previews/redeploy-preview-light.png new file mode 100644 index 000000000..5bfb0c593 Binary files /dev/null and b/images/previews/redeploy-preview-light.png differ diff --git a/settings/preview-deployments.mdx b/settings/preview-deployments.mdx index 9d01bd45e..70cdbfed6 100644 --- a/settings/preview-deployments.mdx +++ b/settings/preview-deployments.mdx @@ -5,20 +5,51 @@ icon: "scan-eye" --- - Preview Deployments are available on the [Growth and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). Please{" "} + Preview deployments are available on [Growth and Enterprise plans](https://mintlify.com/pricing?ref=preview-deployments). Please{" "} contact sales for more information. -Preview Deployments allow you to preview changes to your docs in a live deployment without merging those changes to your production branch. +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. -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. +## Creating preview deployments -## Sharing Preview Deployments +Preview deployments are created automatically through pull requests or manually from your dashboard. -After generating a preview URL, you can share that link with anybody for them to view. +### Automatic previews -### Authenticated Preview Deployments +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. -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. + + Link to view deployment in the pull request timeline + Link to view deployment in the pull request timeline + -To set up preview deployment authentication, please [contact sales](mailto:sales@mintlify.com). +### Manual previews + +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. + +1. Go to your [dashboard](https://dashboard.mintlify.com/). +2. Select **Previews**. +3. Select **Create preview**. +4. Enter your branch name. +5. Select **Create deployment**. + +## Redeploying a preview + +Redeploy a preview to refresh content or retry after a failed deployment. + +1. Select the preview from your [dashboard](https://dashboard.mintlify.com/). +2. Select **Redeploy**. + + + The Previews menu with the deploy button emphasized by an orange rectangle. + The Previews menu with the deploy button emphasized by an orange rectangle. + + +## Sharing preview deployments + +Preview deployments can be publicly accessible or restricted to authenticated users. + +**Public access**: Preview URLs are publicly viewable by default. Share a preview link with anyone who needs to review your changes. + +**Restricted access**: Enable preview deployment authentication to limit preview access to authenticated Mintlify users only. [Contact sales](mailto:sales@mintlify.com) to set up authentication for your previews.