Skip to content

Commit

Permalink
screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
ritazagoni committed Jun 19, 2024
1 parent 8ee1c7b commit 995ae58
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 19 deletions.
47 changes: 28 additions & 19 deletions docs/manage-projects/collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,14 @@ editing or viewing privileges on a project. Collaborators are granted ONE of
four key roles in a project they that can access as highlighted in the table
below:

| Role | Description |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------- |
| Owner | The user who created the project |
| Admin | A user who is not the owner of a project but has unrestricted access to the project and the workflows included. |
| Editor | A user with access to a project and is able to edit workflows and project related settings. An editor role is limited compared to the Admin |
| Viewer | A user with access to a project but only limited to viewing the project settings and artifacts. |

Learn more about the permissions of these roles
| Role | Description |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Owner | The user who created the project |
| Admin | A user who is not the owner of a project but has unrestricted access to the project and the workflows included. Also has permission to add other collaborators to the project. |
| Editor | A user with access to a project and is able to edit workflows and project related settings. An editor role is limited compared to the admin |
| Viewer | A user with access to a project but only limited to viewing the project settings and artifacts. |

You can learn more about the permissions of each role
[here](https://docs.openfn.org/documentation/manage-projects/user-roles-permissions).

### Adding a collaborator
Expand All @@ -36,22 +36,31 @@ Currently the invited user has to have an OpenFn account already to be able to
be invited as collaborator. New users can request an account
[here](https://www.openfn.org/register).

To addBy adding an existing user to a project, the new collaborator must have an
email that is already registered as a user on OpenFn.
To add this existing user:

1. Go to the project settings, navigate to the collaborators tab and click the
`Add new collaborator` button
2. From the `Settings` page, follow the steps below: Click on
`Add Collaborator(s`)
3. Provide the email address of the user and select the `Role`: Viewer, Editor
or Admin
4. Add more collaborators by clicking the `Add Additional Collaborator` button
5. Save your collaborators by clicking the `Save Collaborator` button

![Collaboration](/img/collaboration.png)

![Add collaborator](/img/add_collab.png)

:::note

To add this existing user, go to the project settings, navigate to the
collaborators tab and click the Add new collaborator button. From the settings
page, follow the steps below: Click on `Add Collaborator(s`) Provide the email
address of the user and select the Role (see options above) Add more
collaborators by clicking the “Add Additional Collaborator” button Save your
collaborators by clicking the “Save Collaborator” button
A project can have exactly _one_ owner and you will not be able to assign an
owner role to a collaborator.

::: note A project can have exactly _one_ owner and you will not be able to
assign an owner role to a collaborator. :::
:::

### Removing a collaborator

To remove a collaborator from a project, a collaborator owner, editor or admin
can click the `Remove Collaborator` button on the `Collaboration` page in the
project `Settings` and confirm the removal through the pop up window. The owner
of the project cannot be removed.
of a project cannot be removed.
2 changes: 2 additions & 0 deletions sidebars-main.js
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,8 @@ module.exports = {
'manage-projects/link-to-gh',
'manage-projects/webhook-auth',
'manage-projects/workflow-dashboard',
'manage-projects/collaboration',

],
},
{
Expand Down
Binary file added static/img/add_collab.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 added static/img/collaboration.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 995ae58

Please sign in to comment.