1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-02-28 00:17:12 +01:00

feat: add private collaboration mode docs (#5750)

This commit is contained in:
Jaanus Sellin 2024-01-04 10:48:02 +02:00 committed by GitHub
parent e0c9ef6d2f
commit d779faf56d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 10 additions and 2 deletions

View File

@ -11,6 +11,7 @@ The project collaboration mode is an enterprise-only feature that was introduced
A project's **collaboration mode** specifies **who can submit [change requests](change-requests.md)**. There are two collaboration modes: A project's **collaboration mode** specifies **who can submit [change requests](change-requests.md)**. There are two collaboration modes:
- [**open**](#open-collaboration-mode) - [**open**](#open-collaboration-mode)
- [**protected**](#protected-collaboration-mode) - [**protected**](#protected-collaboration-mode)
- [**private**](#private-collaboration-mode)
## **Open** collaboration mode ## **Open** collaboration mode
@ -22,6 +23,12 @@ The open collaboration mode is the default in Unleash and is how all projects wo
Only admins and project members can submit change requests in a **protected** project. Other users can not submit change requests. Only admins and project members can submit change requests in a **protected** project. Other users can not submit change requests.
## **Private** collaboration mode
Private collaboration mode renders the project invisible to all **viewers** who are not project members. This means that **viewers** cannot see the project in the project list, nor can they access the project's features or locate the project anywhere within Unleash.
**Editors** and **admins** can still see private projects.
### Change requests ### Change requests
When you change a project's collaboration mode from open to protected, users who do not have the right permissions will lose the ability to create new change requests. When you change a project's collaboration mode from open to protected, users who do not have the right permissions will lose the ability to create new change requests.
@ -30,10 +37,11 @@ However, existing change requests created by these users will not be deleted. An
## Project collaboration mode setting ## Project collaboration mode setting
You can set a project's collaboration mode when you create a project and at any point after creation. The collaboration mode for a project can be set at the time of creation and modified at any subsequent time, found within the 'Enterprise Settings' section.
![Project creation form with a collaboration mode field and corresponding explanation.](/img/collaboration-mode.png) ![Project creation form with a collaboration mode field and corresponding explanation.](/img/collaboration-mode.png)
Because the project's collaboration mode is a core part of the project, the controls to change it are available on the "edit project" page.
Since the collaboration mode is an integral feature of the project, the options to modify it can be found on the 'Project Settings' page.
![The project-level header section with the "edit project" button highlighted.](/img/edit-project.png) ![The project-level header section with the "edit project" button highlighted.](/img/edit-project.png)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 155 KiB

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 110 KiB

After

Width:  |  Height:  |  Size: 17 KiB

BIN
website/static/img/img.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB