diff --git a/dashboard/roles.mdx b/dashboard/roles.mdx index 781c4ee71..dfe7214a0 100644 --- a/dashboard/roles.mdx +++ b/dashboard/roles.mdx @@ -20,6 +20,7 @@ The following describes actions that are limited to the Admin role: | Manage & update billing | ❌ | ✅ | | Update custom domain | ❌ | ✅ | | Update Git source | ❌ | ✅ | +| Delete deployment | ❌ | ✅ | | Delete org | ❌ | ✅ | Other actions on the dashboard are available to both roles. diff --git a/deploy/deployments.mdx b/deploy/deployments.mdx index 1c96dfcff..37086fd02 100644 --- a/deploy/deployments.mdx +++ b/deploy/deployments.mdx @@ -24,3 +24,31 @@ If the GitHub app is connected, but changes are still not deploying, you can man + +## Deleting a deployment + +You can delete individual deployments from the danger zone in your organization settings. This is useful when you want to remove a specific deployment without affecting your entire organization. + + + Deleting a deployment is permanent and cannot be undone. All associated data, including preview deployments, will be deleted. + + +### Required permissions + +To delete a deployment, you need the `deployment.delete` permission. This permission is typically granted to Admin users. See [Roles](/dashboard/roles) for more information about permissions. + +### What happens after deletion + +When you delete a deployment: + +- All deployment data and artifacts are permanently removed +- Preview deployments associated with the deployment are deleted +- If you have an active subscription, you'll receive a prorated credit for any unused time +- You'll be redirected to another deployment in your organization, or to the Mintlify homepage if no other deployments exist + +### Deleting a deployment vs. deleting an organization + +- **Deleting a deployment**: Removes a single deployment while keeping your organization, other deployments, and team members intact +- **Deleting an organization**: Permanently removes your entire organization, all deployments, team members, and data + +To delete a deployment, navigate to **Settings** > **Organization** > **Danger zone** in your dashboard.