Skip to content
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

update collaborator docs #706

Merged
merged 21 commits into from
Oct 22, 2024
Merged
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
54 changes: 32 additions & 22 deletions docs/getting-started/collaborate/invite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,25 +31,35 @@ In order to add collaborators, your project must either be a

## Available roles {#roles}

| Role | Abilities |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Project Owner** | All Project abilities including deletion. At this time, project ownership is not transferable. |


### Supergraph

| Role | Abilities |
|---------------|----------------------------------------------------------------------|
| **Admin** | Same as a Project Owner, excluding deletion of the project. |
| **Read Only** | A user with this role is only able to explore and visualize the API. |

### Subgraph

| Role | Abilities |
|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------|
| **Admin** | All subgraph-related abilities: create subgraph build, apply subgraph build to endpoint, create supergraph with subgraph patch, invite other subgraph admins. |
| **Developer** | Same as a subgraph Admin, excluding the ability to invite others and apply subgraph build to endpoint. |

| Role | Abilities |
|--------------------------|------------------------------------------------------------------------------------------------------|
| **Owner** | All Project abilities including deletion. At this time, project ownership is not transferable. |
| **Admin** | Same as a Project Owner, excluding deletion of the project. |
| **Read Only** | Only explore and visualize the supergraph. |
| **Subgraph Admin** * | All subgraph development-related abilities: create subgraph build, apply subgraph build to endpoint. |
| **Subgraph Developer** * | Same as a subgraph admin, excluding the ability to apply subgraph build to endpoint. |

\* Subgraph roles are only available on [DDN Advanced projects](https://hasura.io/pricing/ddn).

The following are the detailed permissions for the above roles:

| Permissions | Owner | Admin | Read Only | Subgraph<br/> Admin * | Subgraph<br/> Developer * |
|--------------------------------------------------------------------|-------|-------|-----------|-----------------------|---------------------------|
| View Supergraph Explorer | ✅ | ✅ | ✅ | ✅ | ✅ |
| Make GraphQL API requests | ✅ | ✅ | ✅ | ✅ | ✅ |
| View project insights | ✅ | ✅ | ✅ | ✅ | ✅ |
| Create supergraph builds<br/> - using all subgraphs' metadata | ✅ | ✅ | ❌ | ❌ | ❌ |
| Create supergraph builds<br/> - using single subgraph's metadata * | ✅ | ✅ | ❌ | ✅ | ✅ |
| Apply supergraph builds to project endpoint | ✅ | ✅ | ❌ | ❌ | ❌ |
| Create subgraph builds * | ✅ | ✅ | ❌ | ✅ | ✅ |
| Apply subgraph builds to project endpoint * | ✅ | ✅ | ❌ | ✅ | ❌ |
| Admin permissions on all subgraphs | ✅ | ✅ | ❌ | ❌ | ❌ |
| Create / Delete subgraphs | ✅ | ✅ | ❌ | ❌ | ❌ |
| Add / Remove collaborators | ✅ | ✅ | ❌ | ❌ | ❌ |
| Manage project plans and billing | ✅ | ✅ | ❌ | ❌ | ❌ |
| Delete project | ✅ | ❌ | ❌ | ❌ | ❌ |

\* Only available on [DDN Advanced projects](https://hasura.io/pricing/ddn).

## How to invite collaborators {#invite-collaborators}

Expand All @@ -64,12 +74,12 @@ from the `Project Settings` menu:
### Step 2. Enter information

Click the `+ Invite Collaborator` button in the top-right corner of the `Collaborators` section and enter the
collaborator's email address, supergraph or subgraph access level and select their role, and, for subgraph access,
their roles per subgraph.
collaborator's email address, select the access level you'd like to assign them, and click `Invite`.

<Thumbnail src="/img/ci-cd/0.0.1_console_assign-collaborator-role.png" alt="Invite a collaborator" width="1000" />

:::info Subgraph Collaborators Only available on DDN Advanced
<br />
:::info Granular Access (Subgraph Collaborators) Only available on DDN Advanced

In order to add subgraph collaborators, your project must be a [DDN Advanced project](https://hasura.io/pricing/ddn).

Expand Down
Binary file modified static/img/ci-cd/0.0.1_console_assign-collaborator-role.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/img/ci-cd/0.0.1_console_invite-collaborator.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading