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 collaboration with inviting new users #523

Merged
merged 2 commits into from
Jul 27, 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: 30 additions & 24 deletions docs/manage-projects/collaboration.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ features such as version control, adding collaborators and sharing credentials
among others. This guide walks you through how to manage collaborators in a
projects.

### Who are Project Collaborators?
### Who are project collaborators?

A `Project Collaborator` is any one who has been granted administrative
editing or viewing privileges on a OpenFn Project. Collaborators are granted ONE of
four key roles in a project they that can access as highlighted in the table
A **project collaborator** is any one who has been granted administrative
editing or viewing privileges on a OpenFn Project. Collaborators are granted ONE
of four key roles in a project they that can access as highlighted in the table
below:

| Role | Description |
Expand All @@ -28,41 +28,47 @@ below:
You can learn more about the permissions of each role
[here](../manage-projects/user-roles-permissions.md)

### Add Collaborator(s)
### Add project collaborator(s)

A user with one of the owner, admin or editor roles in a project can invite new
collaborators to their OpenFn project via the project `Settings` page.
Currently, the invited Collaborator must have an OpenFn user account already setup to be able to
be invited as Collaborator. New users can request an account
[here](https://www.openfn.org/register).

To add an existing OpenFn user as a Collaborator:
To add an existing OpenFn user as a collaborator:

1. Go to the project `Settings` page, navigate to the `Collaboration` tab
2. Click the button `Add Collaborator(s`)
3. Enter 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. Click the `Save Collaborator` button to save your changes
1. Go to the project `Settings` page, navigate to the `Collaboration` tab
2. Click the button `Add Collaborator(s)`
3. Enter 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.
You can also remove one of the collaborators by clicking on the minus (-)
button.
5. Click the `Save Collaborator` button to save your changes.

If any of the email addresses entered does not have an OpenFn account
associated, you will be requested to authorize OpenFn to create an account for
them and send them an invite to your project. Click `Invite new user` to proceed
with the invitation.

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

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

![Invite new users](/img/invite-new-users.png)

:::note

A project can have exactly _one_ Ewner and you will not be able to assign an
owner role to another collaborator. If you need to change the project Owner,
A project can have exactly _one_ Owner and you will not be able to assign an
owner role to another collaborator. If you need to change the project Owner,
contact your Super Admin or [support@openfn.org](mailto:support@openfn.org).

:::

### Removing a Collaborator
### Removing a collaborator

To remove a Collaborator from a project, an owner or admin
can click the `Remove Collaborator` button on the `Collaboration` page and confirm the removal through the pop up window. The owner
of a project cannot be removed.
To remove a Collaborator from a project, an owner or admin can click the
`Remove Collaborator` button on the `Collaboration` page and confirm the removal
through the pop up window. The owner of a project cannot be removed.

:::tip
It is also through this page where you can set receiving failure alerts and digests for your projects. Learn more about it [in this guide](../manage-projects/notifications.md).
:::
:::tip The project collaborators page is also where you can configure failure
alerts and digests for your projects. Learn more about it
[in this guide](../manage-projects/notifications.md). :::
Binary file added static/img/invite-new-users.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.