Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion deploy/deployments.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@

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](/deploy/github#troubleshooting) for more information.

Check warning on line 9 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L9

Use 'aren't' instead of 'are not'.

Check warning on line 9 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L9

In general, use active voice instead of passive voice ('is installed').

If the GitHub app is connected, but changes are still not deploying, you can manually trigger a rebuild from your dashboard.

Check warning on line 11 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L11

In general, use active voice instead of passive voice ('is connected').

## Manually triggering a deployment
## Manually trigger a deployment

<Steps>
<Step title="Verify your latest commit was successful.">
Check that your latest commit appears in your docs repository and did not encounter any errors.

Check warning on line 17 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L17

Use 'didn't' instead of 'did not'.
</Step>
<Step title="Manually trigger a deployment.">
Go to your [dashboard](https://dashboard.mintlify.com) and select the deploy button.
Expand All @@ -24,3 +24,23 @@
</Frame>
</Step>
</Steps>

## Delete a deployment

You can permanently delete a deployment from the [Danger zone](https://dashboard.mintlify.com/settings/organization/danger-zone) in your dashboard settings. This action is irreversible and will remove all deployment data, including any associated preview deployments.

Check warning on line 30 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L30

Avoid using 'will'.

<Steps>
<Step title="Navigate to the Danger zone.">
Go to the [Danger zone](https://dashboard.mintlify.com/settings/organization/danger-zone) in the settings page of your dashboard.
</Step>
<Step title="Delete the deployment.">
1. In the **Delete my deployment** section, provide a reason for deletion.

Check warning on line 37 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L37

Avoid first-person pronouns such as 'my'.
2. Click the delete button. You'll be asked to confirm the deletion.

Check warning on line 38 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L38

In general, use active voice instead of passive voice ('be asked').
</Step>
</Steps>

<Warning>
Deleting a deployment is permanent and cannot be undone. If you have an active subscription, you'll receive a prorated credit for any unused time remaining in your billing period.

Check warning on line 43 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L43

Use 'can't' instead of 'cannot'.
</Warning>

If you have multiple deployments, you'll be redirected to another deployment after deletion. If this was your only deployment, you'll be redirected to the Mintlify homepage.

Check warning on line 46 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L46

In general, use active voice instead of passive voice ('be redirected').

Check warning on line 46 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L46

In general, use active voice instead of passive voice ('be redirected').