Skip to content

Clarify viewer role access in the web editor #4616

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify-development wants to merge 1 commit into from
Closed

Clarify viewer role access in the web editor #4616

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 2 additions & 0 deletions dashboard/permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ keywords: ["editor access", "permissions", "team", "seats", "deployment"]

People with the editor or admin [role](/dashboard/roles) can use the web editor, trigger deployments, and manage integrations from your dashboard. When an editor or admin publishes through the web editor or merges a pull request into your documentation repository, the changes deploy to your live site automatically.

[Viewers](/dashboard/roles#viewer-access-in-the-web-editor) can open the web editor to browse content and make suggestions, but they cannot edit content directly, upload media, or publish changes.

Anyone with access to your documentation repository can contribute to your documentation by pushing changes to the repository, but their changes do not deploy until an editor or admin manually triggers a deployment from your dashboard.
56 changes: 37 additions & 19 deletions dashboard/roles.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Roles"
description: "Assign admin, editor, or viewer roles to manage team access and permissions."
keywords: ["RBAC", "role-based access control", "admin", "editor", "viewer", "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>
Expand All @@ -10,30 +10,48 @@

Mintlify provides three dashboard access levels: viewer, editor, and admin.

| | Viewer | Editor | Admin |
| ------------------------------ | :----: | :----: | :---: |
| View content in the editor | ✅ | ✅ | ✅ |
| View dashboard and analytics | ✅ | ✅ | ✅ |
| Edit content in the web editor | ❌ | ✅ | ✅ |
| Trigger deployments | ❌ | ✅ | ✅ |
| Create and delete API keys | ❌ | ✅ | ✅ |
| Configure integrations | ❌ | ✅ | ✅ |
| Configure assistant | ❌ | ✅ | ✅ |
| Configure add-ons | ❌ | ✅ | ✅ |
| Invite editors and viewers | ❌ | ✅ | ✅ |
| Update user roles | ❌ | ❌ | ✅ |
| Invite admins | ❌ | ❌ | ✅ |
| Delete users | ❌ | ❌ | ✅ |
| Manage billing | ❌ | ❌ | ✅ |
| Manage SSO | ❌ | ❌ | ✅ |
| Update custom domain | ❌ | ❌ | ✅ |
| Update Git source | ❌ | ❌ | ✅ |
| Delete organization | ❌ | ❌ | ✅ |
| | Viewer | Editor | Admin |
| ---------------------------------------- | :----: | :----: | :---: |
| View content in the editor | ✅ | ✅ | ✅ |
| View dashboard and analytics | ✅ | ✅ | ✅ |
| Add comments and suggestions | ✅ | ✅ | ✅ |
| Edit content in the web editor | ❌ | ✅ | ✅ |
| Upload media | ❌ | ✅ | ✅ |
| Publish changes | ❌ | ✅ | ✅ |
| Trigger deployments | ❌ | ✅ | ✅ |
| Create and delete API keys | ❌ | ✅ | ✅ |
| Configure integrations | ❌ | ✅ | ✅ |
| Configure assistant | ❌ | ✅ | ✅ |
| Configure add-ons | ❌ | ✅ | ✅ |
| Invite editors and viewers | ❌ | ✅ | ✅ |
| Update user roles | ❌ | ❌ | ✅ |
| Invite admins | ❌ | ❌ | ✅ |
| Delete users | ❌ | ❌ | ✅ |
| Manage billing | ❌ | ❌ | ✅ |
| Manage SSO | ❌ | ❌ | ✅ |
| Update custom domain | ❌ | ❌ | ✅ |
| Update Git source | ❌ | ❌ | ✅ |
| Delete organization | ❌ | ❌ | ✅ |

<Tip>
Limit admin access to only the people who need to perform admin tasks.
</Tip>

## Viewer access in the web editor

Viewers can open the web editor to browse content and participate in collaboration. When a viewer opens the editor, they are automatically placed in [suggesting mode](/editor/suggestions) and cannot switch to direct editing.

In suggesting mode, viewers can:
- Browse and read all pages
- Make text suggestions that editors and admins can accept or reject
- Leave [comments](/editor/comments) and reply to existing threads

Viewers cannot:
- Edit content directly
- Upload images or videos
- Publish changes or create pull requests
- Toggle off suggesting mode

## Add members to your organization

By default, the person who creates your Mintlify organization has admin access. Add additional editors in the [Members](https://dashboard.mintlify.com/settings/organization/members) page of your dashboard.
Expand Down
4 changes: 4 additions & 0 deletions editor/suggestions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ While suggesting mode is active, the **Suggesting** indicator appears in the edi

To exit suggesting mode, click the **Suggesting** indicator.

<Note>
[Viewers](/dashboard/roles#viewer-access-in-the-web-editor) are automatically placed in suggesting mode when they open the editor and cannot switch to direct editing.
</Note>

<Frame>
<img
src="/images/editor/suggesting-light.png"
Expand Down
Loading