diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/board-configuration.markdown | 44 | ||||
| -rw-r--r-- | docs/calendar-settings.markdown | 42 | ||||
| -rw-r--r-- | docs/calendar.markdown | 6 | ||||
| -rw-r--r-- | docs/project-settings.markdown | 39 |
4 files changed, 87 insertions, 44 deletions
diff --git a/docs/board-configuration.markdown b/docs/board-configuration.markdown index dda9787f..1c5ff51a 100644 --- a/docs/board-configuration.markdown +++ b/docs/board-configuration.markdown @@ -1,8 +1,5 @@ Board settings -=============== - -Some parameters for boards can be changed on the settings page. -Only administrators can change those settings. +============== Go to the menu **Settings**, then choose **Board settings** on the left. @@ -25,42 +22,3 @@ When you share a board, the page will refresh automatically every 60 seconds by When your web browser is open on a board, Kanboard check every 10 seconds if something have been changed by someone else. Technically this process is done by Ajax polling. - -### Default columns for new projects - -You can change the default column names here. -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. - -### Allow only one subtask in progress at the same time for a user - -When this option is enabled, a user can work with only one subtask at the time. - -If another subtask have the status "in progress", the user will see this dialog box: - - - -### 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. - -### Show subtask estimates in the user calendar - -When enabled, assigned subtasks with the status "todo" and with a defined estimate value will be displayed on the user calendar. - -The user calender is available on the dashboard or from the user profile.
\ No newline at end of file diff --git a/docs/calendar-settings.markdown b/docs/calendar-settings.markdown new file mode 100644 index 00000000..c69c9b85 --- /dev/null +++ b/docs/calendar-settings.markdown @@ -0,0 +1,42 @@ +Calendar settings +================= + +Go to the menu **Settings**, then choose **Calendar settings** on the left. + + + +There are two different calendars in Kanboard: + +- Project calendar +- User calendar (available from the dashboard) + +Project calendar +---------------- + +This calendar show tasks with defined due date and tasks based on the creation date or the start date. + +### Show tasks based on the creation date + +The start date of the calendar event is the creation date of the task. +The end date of the event is the date of completion. + +### Show tasks based on the start date + +The start date of the calendar event is the start date of the task. +This date can be defined manually. +The end date of the event is the date of completion. +If there is no start date the task will not appear on the calendar. + +User calendar +------------- + +This calendar show only tasks assigned to the user and optionally subtasks information. + +### Show subtasks based on the time tracking + +Display subtasks in the calendar from the information recorded in the time tracking table. +The intersection with the user timetable is also calculated. + +### Show subtask estimates (forecast of future work) + +Display the estimate of future work for subtasks in status "todo" and with a defined "estimate" value. diff --git a/docs/calendar.markdown b/docs/calendar.markdown index 7b5be5fb..1dd4a08a 100644 --- a/docs/calendar.markdown +++ b/docs/calendar.markdown @@ -9,6 +9,10 @@ There are two different views for the calendar: At this time the calendar is able to display these information: - Tasks with a due date, displayed at the top. The date can be changed by moving the task to another day. -- Subtask time tracking, each recorded time slot will be shown in the calendar. +- Tasks based on the creation date or the start date. These events cannot be modified with the calendar. +- Subtask time tracking, all recorded time slot will be shown in the calendar. +- Subtask estimates, forecast of work left  + +The calendar configuration can be changed in the settings page. diff --git a/docs/project-settings.markdown b/docs/project-settings.markdown new file mode 100644 index 00000000..5cfa4974 --- /dev/null +++ b/docs/project-settings.markdown @@ -0,0 +1,39 @@ +Project settings +================ + +Go to the menu **Settings**, then choose **Project settings** on the left. + + + +### Default columns for new projects + +You can change the default column names here. +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. + +### Allow only one subtask in progress at the same time for a user + +When this option is enabled, a user can work with only one subtask at the time. + +If another subtask have the status "in progress", the user will see this dialog box: + + + +### 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. |