From 4a1dc8071fe048092034a58769a78062feb7449c Mon Sep 17 00:00:00 2001 From: Frederic Guillot Date: Sat, 16 May 2015 21:28:03 -0400 Subject: Rename doc files --- docs/calendar-configuration.markdown | 42 ++++++++++++++++++++++++++++++++++++ docs/calendar-settings.markdown | 42 ------------------------------------ docs/project-configuration.markdown | 39 +++++++++++++++++++++++++++++++++ docs/project-settings.markdown | 39 --------------------------------- 4 files changed, 81 insertions(+), 81 deletions(-) create mode 100644 docs/calendar-configuration.markdown delete mode 100644 docs/calendar-settings.markdown create mode 100644 docs/project-configuration.markdown delete mode 100644 docs/project-settings.markdown diff --git a/docs/calendar-configuration.markdown b/docs/calendar-configuration.markdown new file mode 100644 index 00000000..95e13e52 --- /dev/null +++ b/docs/calendar-configuration.markdown @@ -0,0 +1,42 @@ +Calendar settings +================= + +Go to the menu **Settings**, then choose **Calendar settings** on the left. + +![Calendar settings](http://kanboard.net/screenshots/documentation/calendar-settings.png) + +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-settings.markdown b/docs/calendar-settings.markdown deleted file mode 100644 index c69c9b85..00000000 --- a/docs/calendar-settings.markdown +++ /dev/null @@ -1,42 +0,0 @@ -Calendar settings -================= - -Go to the menu **Settings**, then choose **Calendar settings** on the left. - -![Calendar settings](http://kanboard.net/screenshots/documentation/calendar-settings.png) - -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/project-configuration.markdown b/docs/project-configuration.markdown new file mode 100644 index 00000000..5cfa4974 --- /dev/null +++ b/docs/project-configuration.markdown @@ -0,0 +1,39 @@ +Project settings +================ + +Go to the menu **Settings**, then choose **Project settings** on the left. + +![Project settings](http://kanboard.net/screenshots/documentation/project-settings.png) + +### 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: + +![Subtask user restriction](http://kanboard.net/screenshots/documentation/subtask-user-restriction.png) + +### 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/project-settings.markdown b/docs/project-settings.markdown deleted file mode 100644 index 5cfa4974..00000000 --- a/docs/project-settings.markdown +++ /dev/null @@ -1,39 +0,0 @@ -Project settings -================ - -Go to the menu **Settings**, then choose **Project settings** on the left. - -![Project settings](http://kanboard.net/screenshots/documentation/project-settings.png) - -### 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: - -![Subtask user restriction](http://kanboard.net/screenshots/documentation/subtask-user-restriction.png) - -### 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. -- cgit v1.2.3