diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/closing-tasks.markdown | 14 | ||||
| -rw-r--r-- | docs/index.markdown | 4 | ||||
| -rw-r--r-- | docs/notifications.markdown | 30 | ||||
| -rw-r--r-- | docs/project-configuration.markdown | 8 | ||||
| -rw-r--r-- | docs/rss.markdown | 23 | ||||
| -rw-r--r-- | docs/subtasks.markdown | 47 | ||||
| -rw-r--r-- | docs/time-tracking.markdown | 25 |
7 files changed, 133 insertions, 18 deletions
diff --git a/docs/closing-tasks.markdown b/docs/closing-tasks.markdown new file mode 100644 index 00000000..7462b683 --- /dev/null +++ b/docs/closing-tasks.markdown @@ -0,0 +1,14 @@ +Closing tasks +============= + +When a task is closed, they are hidden from the board. However, you can always access to the list of closed tasks from the board menu **Board > Actions > Completed tasks**. + +There are two different way to close a task, from the task dropdown menu on the board: + + + +Or from the task sidebar menu in the task detail view: + + + +Note: When you close a task, all subtasks not completed will be changed to the status "Done".
\ No newline at end of file diff --git a/docs/index.markdown b/docs/index.markdown index 75df4694..6eb6e6ef 100644 --- a/docs/index.markdown +++ b/docs/index.markdown @@ -25,16 +25,19 @@ Using Kanboard ### Working with tasks - [Creating tasks](creating-tasks.markdown) +- [Closing tasks](closing-tasks.markdown) - [Adding screenshots](screenshots.markdown) - [Task links](task-links.markdown) - [Transitions](transitions.markdown) - [Time tracking](time-tracking.markdown) - [Recurring tasks](recurring-tasks.markdown) - [Create tasks by email](create-tasks-by-email.markdown) +- [Subtasks](subtasks.markdown) ### Working with users - [User management](user-management.markdown) +- [Notifications](notifications.markdown) - [Hourly rate](hourly-rate.markdown) - [Timetable](timetable.markdown) - [Two factor authentication](2fa.markdown) @@ -62,6 +65,7 @@ Using Kanboard - [Slack](slack.markdown) - [Postmark](postmark.markdown) - [iCalendar subscriptions](ical.markdown) +- [RSS/Atom subscriptions](rss.markdown) - [Json-RPC API](api-json-rpc.markdown) - [Webhooks](webhooks.markdown) diff --git a/docs/notifications.markdown b/docs/notifications.markdown new file mode 100644 index 00000000..f42c66cb --- /dev/null +++ b/docs/notifications.markdown @@ -0,0 +1,30 @@ +Notifications +============= + +Kanboard is able to send notifications through several channels: + +- Email +- Jabber/XMPP +- Hipchat +- Slack + +Actually, Jabber/Hipchat/Slack notifications are sent to a room or group channel because they are configured at the project level. +However, email notifications are sent to an individual. + +User notifications +------------------ + +Each user must enable the notifications in their profile: **User Profile > Email notifications**. It's disabled by default. + +You need of course a valid email address in you profile and the application must be configured to send emails. + + + +For each project your are member, you can choose to receive notifications for: + +- All tasks +- Only for tasks assigned to you +- Only for tasks created by you +- Only for tasks created by you and assigned to you + +You can also select only some projects, by default it's all projects where you are member. diff --git a/docs/project-configuration.markdown b/docs/project-configuration.markdown index 5cfa4974..d234eca7 100644 --- a/docs/project-configuration.markdown +++ b/docs/project-configuration.markdown @@ -29,11 +29,3 @@ If another subtask have the status "in progress", the user will see this dialog  -### Enable time tracking for subtasks - -When this option is enabled, each time the status of a subtask is changed, the start time and the end time are recorded in the database for the assignee. - -- When the status changes to "in progress" then the start time is saved -- When the status changes to "done" then the end time is saved - -The time spent for the subtask and the task is also updated. diff --git a/docs/rss.markdown b/docs/rss.markdown new file mode 100644 index 00000000..57c81020 --- /dev/null +++ b/docs/rss.markdown @@ -0,0 +1,23 @@ +RSS/Atom subscriptions +====================== + +Kanboard supports RSS feeds for projects and users. + +- Project feeds contains only the activity the project +- User feeds contains the activity stream of all projects the user is member + +Those subscriptions are only activated when the public access is enabled in the user profile or in the project settings. + +Enable/disable project RSS feeds +-------------------------------- + +Go to **Project settings > Public access**. + + + +Enable/disable user RSS feeds +-------------------------------- + +Go to **User profile > Public access**. + +The RSS link is protected by a random token, only people who knows the url can access to the feed.
\ No newline at end of file diff --git a/docs/subtasks.markdown b/docs/subtasks.markdown new file mode 100644 index 00000000..6ea67284 --- /dev/null +++ b/docs/subtasks.markdown @@ -0,0 +1,47 @@ +Subtasks +======== + +Subtasks are useful to split the work of a task. + +Each subtask: + +- Can be assigned to a project member +- Have 3 different statuses: **Todo**, **In progress**, **Done** +- Have time tracking information: **time spent** and **time estimated** +- Be ordered by position + +Creating subtasks +----------------- + +From the task view, on left sidebar click on **Add a subtask**: + + + +You can also add quickly a subtask by entering only the title: + + + +Change subtask status +--------------------- + +When you click on the subtask title the status change: + + + +The icon before the title is updated according to the status. + + + +Note: When the task is closed, all subtasks are changed to the status **Done**. + +Subtask timer +------------- + +Each time a subtask is in progress, the timer is also started. The timer can be started and stopped at any time. + +The timer records the time spent on the subtask automatically. You can also change manually the value of the time spent field when you edit a subtask. + +The time calculated is rounded to the nearest quarter. This information is recorded in a separate table. + +The task time spent is updated automatically according to the sum of all subtasks time spent. + diff --git a/docs/time-tracking.markdown b/docs/time-tracking.markdown index 575a0094..8c65b16a 100644 --- a/docs/time-tracking.markdown +++ b/docs/time-tracking.markdown @@ -21,18 +21,23 @@ Subtask time tracking  Subtasks also have the fields "time spent" and "time estimated". -However, when you set a value for those fields, **the task time tracking values becomes the sum of all subtask values**. -User time tracking ------------------- +When you change the value of these fields, **the task time tracking values are updated automatically and becomes the sum of all subtask values**. + +Kanboard records the time between each subtask status change in a separate table. + +- Changing subtask status from **todo** to **in pogress** logs the start time +- Changing subtask status from **in progress** to **done** logs the end time but also update the time spent of the subtask and the task + +The breakdown of all records is visible in the task view page: -In the board settings, you can enable subtasks time tracking for users. + -Each time a subtask status change, the start time and the end time are saved in a seperate table automatically. -The time spent is automatically calculated for tasks and subtasks when the subtask is completed. +For each subtask, the timer can be stopped/started at any time: -- Changing subtask status from "todo" to "in pogress" logs the start time -- Changing subtask status from "in progress" to "done" logs the end time but also update the time spent of the subtask and the task + -The breakdown by user is also visible in the tasks details: -I
\ No newline at end of file +- The timer doesn't depends of the subtask status +- Each time you start the timer a new record is created in the time tracking table +- Each time you stop the clock the end date is recorded in the time tracking table +- The calculated time spent is rounded to the nearest quarter |