-
Notifications
You must be signed in to change notification settings - Fork 4
Update member permissions docs with new user permissions info #3105
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
742b4e1
Update member permissions docs with new user permissions info
fern-support b3c6ff7
clarify/restructure info
devalog 8c1837c
add info on custom domains permissions
devalog e356ac6
wording update
devalog 2d4371a
add info on per doc site permissions, add changelog entry
devalog File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| ## User permissions | ||
|
|
||
| You can now assign roles to teammates in your organization to control who can publish to production and manage organization settings. Choose from Admin, Editor, or Viewer roles, and optionally restrict access to specific docs sites. | ||
|
|
||
| [Learn more](/learn/dashboard/configuration/permissions) about user permissions. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,47 @@ | ||
| --- | ||
| title: Member permissions | ||
| description: Manage team member roles and access levels in your organization. | ||
| title: User permissions | ||
| description: Manage Dashboard and CLI access for your organization. | ||
| --- | ||
|
|
||
| Use the Fern Dashboard to assign roles to your teammates. | ||
|
|
||
| <Info title="Coming soon"> | ||
| Member permissions are in active development. Reach out via Slack or support@buildwithfern.com for more information. | ||
| </Info> | ||
| Control who can publish to production and manage organization settings by assigning roles in the [Fern Dashboard](https://dashboard.buildwithfern.com/). To assign roles, go to **Settings > Members**. | ||
|
|
||
| ## Role types | ||
|
|
||
| Member roles control what actions someone can take in your organization, such as managing settings, viewing analytics, and publishing to production. [**CLI access**](/learn/cli-api-reference/cli-reference/overview) determines who can publish SDKs and documentation sites to production (local development doesn't require it). | ||
| When a user logs in to their organization via the Dashboard or CLI, they are assigned an Admin, Editor, or Viewer role. By default, all users have Admin permissions unless a different role has been assigned. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🚫 [vale] reported by reviewdog 🐶 |
||
|
|
||
| ### Admin | ||
| Roles control two types of permissions: | ||
|
|
||
| - **Dashboard permissions**: managing organization settings and members, adding or updating custom domains, and viewing analytics. | ||
| - **CLI permissions**: publishing SDKs and documentation to production. Local development and deploying previews don't require CLI access. | ||
|
|
||
| Admins have full administrative access to your Fern organization and full CLI access. They can: | ||
| ### Admin | ||
|
|
||
| - Manage members, including adding and removing roles. | ||
| - Publish SDKs and documentation sites to production. | ||
| Admins have full access to both the Dashboard and CLI, including editing organization settings, managing members, and publishing to production. | ||
|
|
||
| ### Editor | ||
|
|
||
| Editors can work with SDKs and documentation, but can't edit Fern organization settings or manage members. CLI access is enabled or disabled per Editor: | ||
| Editors can view analytics but can't manage organization settings or members. CLI access is configurable per Editor: | ||
|
|
||
| - Editors **with** CLI access can publish SDKs and documentation sites to production. | ||
| - Editors **without** CLI access can't publish to production. | ||
| - All Editors can deploy previews via the CLI. | ||
|
|
||
| ### Viewer | ||
|
|
||
| Viewers have read-only access to the Dashboard and analytics. They can't edit organization settings, manage members, or publish to production. | ||
| Viewers have read-only access to the Dashboard (settings, analytics) and can deploy previews via the CLI. | ||
|
|
||
| ## Permissions by role | ||
|
|
||
| | Permission | Admin | Editor | Viewer | | ||
| |------------|-------|--------|--------| | ||
| | Manage organization settings | ✅ | ❌ | ❌ | | ||
| | Manage members | ✅ | ❌ | ❌ | | ||
| | Publish to production | ✅ | Configure per Editor | ❌ | | ||
| | Generate locally | ✅ | ✅ | ✅ | | ||
| | View dashboard and analytics | ✅ | ✅ | ✅ | | ||
| | Manage organization settings | Yes | No | No | | ||
| | Manage members | Yes | No | No | | ||
| | Add or update a custom domain | Yes | No | No | | ||
| | View dashboard and analytics | Yes | Yes | Yes | | ||
| | Publish to production | Yes | Configure per Editor | No | | ||
| | Deploy previews | Yes | Yes | Yes | | ||
| | Generate locally | Yes | Yes | Yes | | ||
|
|
||
| ## Per-site permissions | ||
|
|
||
| Organizations with multiple docs sites (for example, internal and external documentation) can assign each user a different role per site. A user might be an **Admin** for your internal docs but a **Viewer** for external docs, giving you granular control over who can publish to and manage each site. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated