diff --git a/deploy/preview-deployments.mdx b/deploy/preview-deployments.mdx index 95a81cff8..d53913610 100644 --- a/deploy/preview-deployments.mdx +++ b/deploy/preview-deployments.mdx @@ -39,8 +39,8 @@ A maintainer with write access to the main repository can preview changes from a You can manually create a preview for any branch. -1. Go to your [dashboard](https://app.mintlify.com/). -2. Click **Previews**. +1. In your dashboard, open the organization dropdown in the upper-left corner and click **Settings** to go to the activity dashboard. +2. Click the **Previews** tab. 3. Click **Create custom preview**. 4. Enter the name of the branch you want to preview. 5. Click **Create preview**. @@ -53,8 +53,10 @@ You can also create preview deployments programmatically using the [Trigger prev Redeploy a preview to refresh content or retry after a failed deployment. -1. Click the preview from your [dashboard](https://app.mintlify.com/). -2. Click **Redeploy**. +1. In your dashboard, open the organization dropdown in the upper-left corner and click **Settings** to go to the activity dashboard. +2. Click the **Previews** tab. +3. Click the preview you want to redeploy. +4. Click **Redeploy**. The Previews menu with the deploy button emphasized by an orange rectangle. @@ -81,6 +83,10 @@ The widget only appears on preview deployments, not on your live site or local p By default, preview deployments are publicly accessible to anyone with the URL. You can restrict access by requiring organization authentication for all previews or by password-protecting individual previews. + + Restricting preview access is an Enterprise add-on. It is separate from Pro password protection (which gates production, not previews) and the SSO Login add-on (which gates the dashboard). Contact your account team to enable it. + + ### Require organization authentication Restrict preview access to authenticated members of your Mintlify organization. @@ -96,8 +102,8 @@ Restrict preview access to authenticated members of your Mintlify organization. Password-protect a specific preview to share it with external reviewers without adding them to your Mintlify organization. This option is available when creating a manual preview and is not shown when organization authentication is already enabled for your deployment. -1. Go to your [dashboard](https://app.mintlify.com/). -2. Click **Previews**. +1. In your dashboard, open the organization dropdown in the upper-left corner and click **Settings** to go to the activity dashboard. +2. Click the **Previews** tab. 3. Click **Create custom preview**. 4. Enter the name of the branch you want to preview. 5. Toggle **Make private** on and enter a password. Passwords must be at least 8 characters. @@ -113,7 +119,7 @@ Preview deployments stay live as long as their source branch exists in your repo - **Automatic previews**: The preview for a pull request remains available while the PR is open and after it's merged or closed, as long as the source branch still exists. When you delete the branch, the next dashboard sync removes the preview. - **Manual previews**: Manual previews stay live until you delete them. Redeploying a manual preview refreshes its content against the latest commit on the specified branch. -- **Delete a preview**: In your [dashboard](https://app.mintlify.com/), go to **Previews**, open the preview, and click **Delete** to remove it immediately. +- **Delete a preview**: In your dashboard, open the organization dropdown in the upper-left corner, click **Settings** to go to the activity dashboard, and then click the **Previews** tab. Open the preview and click **Delete** to remove it immediately. Preview URLs are unique per branch. If you delete a preview and later recreate one for the same branch, Mintlify may issue a new URL. @@ -123,7 +129,7 @@ Mintlify generates preview URLs automatically. The subdomain and domain are not If your preview deployment fails, try these troubleshooting steps. -- **View the build logs**: In your [dashboard](https://app.mintlify.com/), go to **Previews** and click the failed preview. The deployment logs show errors that caused failures. +- **View the build logs**: In your dashboard, open the organization dropdown in the upper-left corner, click **Settings** to go to the activity dashboard, and then click the **Previews** tab. Click the failed preview to see the deployment logs. - **Check your configuration**: - Missing `docs.json` at the configured content root. If your `docs.json` is in a subdirectory, confirm the **docs.json is in a subdirectory** setting points to the correct path. - Invalid `docs.json` syntax (for example, an empty file or a stray trailing comma that breaks JSON parsing).