Skip to content

Commit

Permalink
Update the collaborators docs (#702)
Browse files Browse the repository at this point in the history
Co-authored-by: hasura-bot <[email protected]>
Co-authored-by: Rob Dominguez <[email protected]>
  • Loading branch information
3 people authored Oct 16, 2024
1 parent 3f6f597 commit 45952dd
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 20 deletions.
42 changes: 22 additions & 20 deletions docs/getting-started/collaborate/invite.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,26 @@ 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. |

| **Project Admin** | Same as a Project Owner, excluding deletion of the project. |
| **Project Viewer** | A user with this role is only able to explore and visualize the API. |
| **Subgraph Admin** | All subgraph-related abilities: create subgraph build, apply subgraph build to endpoint, create supergraph with subgraph patch, invite other subgraph admins. |
| **Subgraph Developer** | Same as a subgraph admin, excluding the ability to invite others and apply subgraph build to endpoint. |

| Permissions | Project Admin | Project Viewer | Subgraph Admin | Subgraph Developer |
| -------------------------------------------------------------------------- | ------------- | -------------- | -------------- | ------------------ |
| **View Supergraph Explorer** |||||
| **Manage plans and billing** |||||
| **Add collaborators** |||||
| **Create supergraph builds** |||||
| **Apply supergraph build** |||||
| **Admin permissions on all subgraphs in the project** |||||
| **Create subgraphs** |||||
| **Create subgraph builds on the subgraph** |||||
| **Create supergraph build with the subgraph patched** |||||
| **Apply subgraph builds to project endpoint (only their subgraph)** |||||
| **View all subgraphs within the supergraph (only metadata, not env vars)** |||||

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

Expand All @@ -64,12 +66,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.

0 comments on commit 45952dd

Please sign in to comment.