diff --git a/fern/products/dashboard/dashboard.yml b/fern/products/dashboard/dashboard.yml index 7b54272d4..834a563da 100644 --- a/fern/products/dashboard/dashboard.yml +++ b/fern/products/dashboard/dashboard.yml @@ -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 diff --git a/fern/products/dashboard/pages/domains.mdx b/fern/products/dashboard/pages/domains.mdx index 4765a3f0e..24f0d9401 100644 --- a/fern/products/dashboard/pages/domains.mdx +++ b/fern/products/dashboard/pages/domains.mdx @@ -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` diff --git a/fern/products/dashboard/pages/overview.mdx b/fern/products/dashboard/pages/overview.mdx index 324e538fa..1e4ec9c42 100644 --- a/fern/products/dashboard/pages/overview.mdx +++ b/fern/products/dashboard/pages/overview.mdx @@ -18,11 +18,11 @@ Visit your team's [Dashboard](https://dashboard.buildwithfern.com/) and complete Configure your custom domain with automatic DNS record provisioning. - Add team members and assign roles to control their access levels. + Assign Admin, Editor, or Viewer roles to manage Dashboard and CLI access. - Member permissions are in active development. Reach out via Slack or support@buildwithfern.com for more information. - +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. -### 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: + +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. + -- 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 | +