summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-12-06 08:49:28 -0500
committerFrederic Guillot <fred@kanboard.net>2015-12-06 08:49:28 -0500
commitfd16ea680f90d09ada80bc42cefd1b21deb37844 (patch)
treeb74961ed3440b7056509cca1a8bd7434fa703c05 /doc
parentd0e809a32cd58c0d89b2425aeb245e04a94df7d6 (diff)
Add documentation about project types and roles
Diffstat (limited to 'doc')
-rw-r--r--doc/index.markdown2
-rw-r--r--doc/project-types.markdown14
-rw-r--r--doc/roles.markdown25
3 files changed, 41 insertions, 0 deletions
diff --git a/doc/index.markdown b/doc/index.markdown
index 3c0cae97..de23f5f4 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -19,6 +19,7 @@ Using Kanboard
### Working with projects
+- [project-types](project-types.markdown)
- [Creating projects](creating-projects.markdown)
- [Editing projects](editing-projects.markdown)
- [Sharing boards and tasks](sharing-projects.markdown)
@@ -47,6 +48,7 @@ Using Kanboard
### Working with users
+- [Roles](roles.markdown)
- [User management](user-management.markdown)
- [Notifications](notifications.markdown)
- [Two factor authentication](2fa.markdown)
diff --git a/doc/project-types.markdown b/doc/project-types.markdown
new file mode 100644
index 00000000..f44fea0b
--- /dev/null
+++ b/doc/project-types.markdown
@@ -0,0 +1,14 @@
+Project Types
+=============
+
+There are two kind of projects:
+
+| Type | Description |
+|-------------------|-----------------------------------------------------------------------|
+| Team Project | Project with user and group management |
+| Private Project | Project that belongs to only one person, there is no user management |
+
+- Only Administrators and Application Managers can create team projects.
+- Private projects can be created by anyone.
+
+[Read the documentation about roles in Kanboard](roles.markdown)
diff --git a/doc/roles.markdown b/doc/roles.markdown
new file mode 100644
index 00000000..1b65a8c4
--- /dev/null
+++ b/doc/roles.markdown
@@ -0,0 +1,25 @@
+User Roles
+==========
+
+Application Roles
+-----------------
+
+Each Kanboard user has one of these roles:
+
+| Role | Description |
+|---------------|-----------------------------------------------------------------|
+| Administrator | Access to everything |
+| Manager | Can create team projects but cannot change application settings |
+| User | Can create private projects only |
+
+Project Roles
+-------------
+
+Each individual team project can assign a different role to each user and group:
+
+| Role | Description |
+|-----------------|----------------------------------------------------------------------|
+| Project Manager | Can change project settings, access to the Gantt chart and reports |
+| Project Member | Can create tasks and use the board |
+| Project Viewer | Read-only access to the board and tasks |
+