Skip to content

refresh of editor permissions page to include more clarifying questions #646

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+13 −3
Open

refresh of editor permissions page to include more clarifying questions #646

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
16 changes: 13 additions & 3 deletions advanced/dashboard/permissions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,25 @@
title: 'Editor Permissions'
description: 'Allow more members of your team to update your docs'
---
<Note>
Currently, we only support GitHub as a way to manage editor permissions. We are working on implementing role-based access control (RBAC) in the dashbaord to allow users to set an admin who has special permissions such as inviting users.

Check warning on line 6 in advanced/dashboard/permissions.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

advanced/dashboard/permissions.mdx#L6 

Did you really mean 'dashbaord'?
</Note>

The team member who created your initial docs will have update access to your docs, as long as they push to your documentation repo with the same GitHub account that was used while signing up for Mintlify.

If another editor attempts to update the docs while on the free plan, you will see a warning in your git commit check.
## Who is an editor and what permissions do they have?
An editor means the user has access to the web editor, can trigger updates on Github and generate preview deployments (if your plan includes this feature).

## How do I add an editor?
You can add a new editor or a user by going to the [dashboard](https://dashboard.mintlify.com) and clicking on `Invite Members` in the sidebar..
<Warning>
The `Hobby` plan only allows 1 editor. If another editor attempts to update the docs while on this plan, you will see a warning in your git commit check.

<Frame>
<img className="rounded-md" src="/images/editor-gate.png" />
</Frame>

In the details of the git check warning, you'll find the link to upgrade your plan. You can also upgrade your plan on the [dashboard](https://dashboard.mintlify.com) to enable unlimited editors to update your docs. Once you upgrade your plan, trigger a manual update or push another change to deploy your updates.

Learn more about our pricing [here](https://mintlify.com/pricing).
</Warning>