Skip to content
Closed
Show file tree
Hide file tree
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
1 change: 1 addition & 0 deletions dashboard/roles.mdx
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
---
title: "Roles"
description: "Assign Owner, Admin, or Editor roles to manage team access and permissions."
keywords: ["RBAC", "role-based access control", "Admin", "permissions"]

Check warning on line 4 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L4

Spell out 'RBAC', if it's unfamiliar to the audience.
---

<Info>
RBAC functionality is available on [Custom plans](https://mintlify.com/pricing?ref=rbac).

Check warning on line 8 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L8

Use 'capability' or 'feature' instead of 'functionality'.
</Info>

Mintlify provides two dashboard access levels: Editor and Admin.

Check warning on line 11 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L11

': E' should be in lowercase.

The following describes actions that are limited to the Admin role:

Check warning on line 13 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L13

In general, use active voice instead of passive voice ('are limited').

| | Editor | Admin |
| ----------------------- | :----: | :---: |
| Update user roles | ❌ | ✅ |
| Delete users | ❌ | ✅ |
| Invite admin users | ❌ | ✅ |

Check warning on line 19 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L19

Use 'administrator' instead of 'admin'.
| Manage & update billing | ❌ | ✅ |
| Update custom domain | ❌ | ✅ |
| Update Git source | ❌ | ✅ |
| Delete deployment | ❌ | ✅ |
| Delete org | ❌ | ✅ |

Other actions on the dashboard are available to both roles.

You can invite as many admins as you want, but we recommend limiting admin

Check warning on line 28 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L28

Try to avoid using first-person plural like 'we'.

Check warning on line 28 in dashboard/roles.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

dashboard/roles.mdx#L28

Use 'administrator' instead of 'admin'.
access to users who need it.
28 changes: 28 additions & 0 deletions 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

<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,31 @@
</Frame>
</Step>
</Steps>

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

<Warning>
Deleting a deployment is permanent and cannot be undone. All associated data, including preview deployments, will be deleted.

Check warning on line 33 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L33

Use 'can't' instead of 'cannot'.

Check warning on line 33 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L33

Avoid using 'will'.

Check warning on line 33 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L33

In general, use active voice instead of passive voice ('be deleted').
</Warning>

### 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

Check warning on line 45 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L45

In general, use active voice instead of passive voice ('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

Check warning on line 47 in deploy/deployments.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

deploy/deployments.mdx#L47

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

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