⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content
Open
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
2 changes: 1 addition & 1 deletion fern/products/dashboard/dashboard.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ navigation:
path: ./pages/overview.mdx
- section: Configuration
contents:
- page: Member permissions
- page: User permissions
path: ./pages/permissions.mdx
slug: permissions
- page: Set up SSO
Expand Down
2 changes: 1 addition & 1 deletion fern/products/dashboard/pages/domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Set up a custom domain
description: Use the Fern Dashboard to configure your custom domain with DNS records for subdomain, subpath, or root domain hosting.
---

You can use the [Fern Dashboard](https://dashboard.buildwithfern.com/) to configure any of the following custom domain types:
[Admins](/learn/dashboard/configuration/permissions) can use the [Fern Dashboard](https://dashboard.buildwithfern.com/) to configure any of the following custom domain types:
- **Subdomain**: `docs.mydomain.com`
- **Subpath**: `mydomain.com/docs`
- **Root domain**: `mydomain.com`
Expand Down
4 changes: 2 additions & 2 deletions fern/products/dashboard/pages/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete
Configure your custom domain with automatic DNS record provisioning.
</Card>
<Card
title="Add team members"
title="User permissions"
icon="regular users"
href="/learn/dashboard/configuration/permissions"
>
Add team members and assign roles to control their access levels.
Assign Admin, Editor, or Viewer roles to manage Dashboard and CLI access.
</Card>
<Card
title="Integrate GitHub"
Expand Down
44 changes: 25 additions & 19 deletions fern/products/dashboard/pages/permissions.mdx
Original file line number Diff line number Diff line change
@@ -1,42 +1,48 @@
---
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 [email protected] for more information.
</Info>
User permissions control access to both the Fern Dashboard and the [CLI](/learn/cli-api-reference/cli-reference/overview). Use the Dashboard to assign roles to your teammates.

## 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 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'they're' instead of 'they are'.


### 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:
<Note>
You can also restrict a user's access to specific docs sites when assigning their role, rather than granting access to all docs sites in your organization.
</Note>

- Manage members, including adding and removing roles.
- Publish SDKs and documentation sites to production.
### Admin

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 |

Loading