Update docs

This commit is contained in:
Frederic Guillot 2015-01-03 19:41:30 -05:00
parent 5c6b67bd76
commit 07b07c7697
5 changed files with 74 additions and 7 deletions

View File

@ -61,6 +61,7 @@ Documentation
- [Sharing boards and tasks](docs/sharing-projects.markdown)
- [Automatic actions](docs/automatic-actions.markdown)
- [Project permissions](docs/project-permissions.markdown)
- [Swimlanes](docs/swimlanes.markdown)
#### Working with tasks

View File

@ -34,3 +34,10 @@ It's useful if you always create projects with the same columns.
Each column name must be separated by a comma.
By default, Kanboard use those column names: Backlog, Ready, Work in progress and Done.
### Default categories for new projects
Categories are not global to the application but attached to a project.
Each project can have different categories.
However, if you always create the same categories for all your projects, you can define here the list of categories to create automatically.

View File

@ -25,4 +25,4 @@ Creating a private prooject
To create a new private project, click on the top menu **Projects** and click on the link **New private project**.
Note: project names must be unique.
Note: project names must be unique across the application.

View File

@ -1,14 +1,49 @@
Project permissions
===================
To define project permissions, go to the project page and click on **User management**.
A project can have two kinds of people: **project managers** and **project members**.
- Project managers can manage the configuration of the project and access to the reports.
- Project members are standard users, they have less privileges.
When you create a new project, you are automatically assigned as a project manager.
Kanboard administrators can access to everything but they are not necessary project members or managers. Those permissions are defined at the project level.
Permissions for each role
-------------------------
### Project members
- Use the board (create, move and edit tasks)
- Remove only tasks created by themselves
### Project managers
- Use the board
- Configure the project
- Share, rename, duplicate and disable the project
- Manage swimlanes, categories, columns and users
- Edit automatic actions
- CSV Exports
- Remove tasks of any project members
- Access to the analytics section
They **cannot remove the project**.
Manage users and permissions
----------------------------
To define project roles, go to the **project configuration page** then click on **User management**.
### User management
![Project permissions](http://kanboard.net/screenshots/documentation/project-permissions.png)
By default, a new project is visible from nobody except administrators.
The first section tell you who have access to the project.
**Only those users can be assigned to tasks**.
From there, you can choose to add new members, change the role or revoke user access.
![Project default permssions](http://kanboard.net/screenshots/documentation/project-nobody-allowed.png)
### Allow everybody
You can allow only some specific users or choose to allow all Kanboard users.
If you choose to allow everybody (all Kanboard users), the project is considered public.
That means there is no role management anymore. Permissions per user cannot be applied.

24
docs/swimlanes.markdown Normal file
View File

@ -0,0 +1,24 @@
Swimlanes
=========
Swimlanes are horizontal separations in your board.
By example, it's useful to separate software releases, divide your tasks in different products, teams or what ever you want.
Managing swimlanes
------------------
- All projects have a default swimlane.
- If there is more than one swimlane, the board will show all swimlanes.
- You can drag and drop tasks between swimlanes.
To configure swimlanes go to the **project configuration page** and choose the **section Swimlanes**.
[INSERT SCREENSHOT]
From there, you can add a new swimlane or rename the default one.
You can also disable and change the position of the different swimlanes.
- The default swimlane is always on the top but you can hide it.
- Inactive swimlanes are not shown on the board.
- Removing a swimlane doesn't remove tasks assigned to it, those tasks will be moved to the default swimlane.