summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-01-03 19:41:30 -0500
committerFrederic Guillot <fred@kanboard.net>2015-01-03 19:41:30 -0500
commit07b07c7697439dc0e6bdf87f65b4b3bd46f6bfc8 (patch)
treedf1aa8353fc76e4a6fd2d28bb40de4daee28b699
parent5c6b67bd7605485db2b19a8838838b7c4455e3b6 (diff)
Update docs
-rw-r--r--README.markdown1
-rw-r--r--docs/board-configuration.markdown7
-rw-r--r--docs/creating-projects.markdown2
-rw-r--r--docs/project-permissions.markdown47
-rw-r--r--docs/swimlanes.markdown24
5 files changed, 74 insertions, 7 deletions
diff --git a/README.markdown b/README.markdown
index e4cb7255..c594707c 100644
--- a/README.markdown
+++ b/README.markdown
@@ -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
diff --git a/docs/board-configuration.markdown b/docs/board-configuration.markdown
index d1f74f0d..174618c2 100644
--- a/docs/board-configuration.markdown
+++ b/docs/board-configuration.markdown
@@ -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.
diff --git a/docs/creating-projects.markdown b/docs/creating-projects.markdown
index c2c6cf3d..e093e4b4 100644
--- a/docs/creating-projects.markdown
+++ b/docs/creating-projects.markdown
@@ -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.
diff --git a/docs/project-permissions.markdown b/docs/project-permissions.markdown
index f609aeb1..af3adcd6 100644
--- a/docs/project-permissions.markdown
+++ b/docs/project-permissions.markdown
@@ -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.
+
+### Allow everybody
-![Project default permssions](http://kanboard.net/screenshots/documentation/project-nobody-allowed.png)
+If you choose to allow everybody (all Kanboard users), the project is considered public.
-You can allow only some specific users or choose to allow all Kanboard users.
+That means there is no role management anymore. Permissions per user cannot be applied.
diff --git a/docs/swimlanes.markdown b/docs/swimlanes.markdown
new file mode 100644
index 00000000..b899ffc4
--- /dev/null
+++ b/docs/swimlanes.markdown
@@ -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.
+