From f1d6673050dfa9e642ba634728e5349bdcbbd644 Mon Sep 17 00:00:00 2001 From: Frederic Guillot Date: Sun, 11 Sep 2016 21:53:52 -0400 Subject: Add documentation for custom project roles --- doc/custom-project-roles.markdown | 45 ++++++++++++++++++++++++++++++++++++ doc/index.markdown | 1 + doc/screenshots/custom_roles.png | Bin 0 -> 13582 bytes doc/screenshots/new_custom_role.png | Bin 0 -> 7114 bytes doc/screenshots/new_restriction.png | Bin 0 -> 13609 bytes doc/screenshots/restrictions.png | Bin 0 -> 25222 bytes 6 files changed, 46 insertions(+) create mode 100644 doc/custom-project-roles.markdown create mode 100644 doc/screenshots/custom_roles.png create mode 100644 doc/screenshots/new_custom_role.png create mode 100644 doc/screenshots/new_restriction.png create mode 100644 doc/screenshots/restrictions.png (limited to 'doc') diff --git a/doc/custom-project-roles.markdown b/doc/custom-project-roles.markdown new file mode 100644 index 00000000..4e81d1f1 --- /dev/null +++ b/doc/custom-project-roles.markdown @@ -0,0 +1,45 @@ +Custom Project Roles +==================== + +You can create custom project roles to apply a set of specific restrictions on the people that belong to this role. +These custom roles are defined for each project. + +A custom role inherits from the project member role. +For example, you may want to create a custom role to force someone to follow a process. +You can have a group of people that are allowed to move tasks only from the column "Work in progress" to the column "Done". + +Available restrictions +---------------------- + +- Task creation is not permitted +- Moving tasks only from a given column to another one + +Configuration +------------- + +### 1) Create a new custom role + +From the project settings, click on the left on the menu **Custom Roles** and at the top of the page click on **Add a new custom role**. + +![New custom role](screenshots/new_custom_role.png) + +Give a name to the role and submit the form. + +### 2) Add a restriction to the role + +Each role is grouped in a table. +You can click on the dropdown menu in the table to add a new restriction. + +![New column restriction](screenshots/new_restriction.png) + +If you choose a column restriction, you just need to select the source and the destination column. + +### 3) List of restrictions + +![List of restrictions](screenshots/restrictions.png) + +### 4) Assign the role to someone + +Go to the "permissions" section on the left menu and assign the desired role to the user. + +![Custom project role](screenshots/custom_roles.png) diff --git a/doc/index.markdown b/doc/index.markdown index bc3e8a32..b510190d 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -32,6 +32,7 @@ Using Kanboard - [Gantt chart for tasks](gantt-chart-tasks.markdown) - [Gantt chart for projects](gantt-chart-projects.markdown) - [Custom filters](custom-filters.markdown) +- [Custom project roles](custom-project-roles.markdown) ### Working with tasks diff --git a/doc/screenshots/custom_roles.png b/doc/screenshots/custom_roles.png new file mode 100644 index 00000000..be654c81 Binary files /dev/null and b/doc/screenshots/custom_roles.png differ diff --git a/doc/screenshots/new_custom_role.png b/doc/screenshots/new_custom_role.png new file mode 100644 index 00000000..6ea69f27 Binary files /dev/null and b/doc/screenshots/new_custom_role.png differ diff --git a/doc/screenshots/new_restriction.png b/doc/screenshots/new_restriction.png new file mode 100644 index 00000000..fd26c8fe Binary files /dev/null and b/doc/screenshots/new_restriction.png differ diff --git a/doc/screenshots/restrictions.png b/doc/screenshots/restrictions.png new file mode 100644 index 00000000..dad378ba Binary files /dev/null and b/doc/screenshots/restrictions.png differ -- cgit v1.2.3