Update documentation

This commit is contained in:
Frederic Guillot 2015-02-21 21:05:56 -05:00
parent 2b3f0b6179
commit 19d061db71
7 changed files with 122 additions and 0 deletions

View File

@ -73,10 +73,13 @@ Documentation
- [Automatic actions](docs/automatic-actions.markdown)
- [Project permissions](docs/project-permissions.markdown)
- [Swimlanes](docs/swimlanes.markdown)
- [Calendar](docs/calendar.markdown)
#### Working with tasks
- [Creating tasks](docs/creating-tasks.markdown)
- [Task links](docs/task-links.markdown)
- [Time tracking](docs/time-tracking.markdown)
#### Working with users
@ -84,8 +87,10 @@ Documentation
#### Settings
- [Keyboard shortcuts](docs/keyboard-shortcuts.markdown)
- [Application settings](docs/application-configuration.markdown)
- [Board settings](docs/board-configuration.markdown)
- [Link settings](docs/link-labels.markdown)
### Integrations

View File

@ -41,3 +41,20 @@ 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.

14
docs/calendar.markdown Normal file
View File

@ -0,0 +1,14 @@
Calendar
========
There are two different views for the calendar:
- The project view with filters (available from the board)
- The user view (available from the dashboard and from the user section)
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.
![Calendar](http://kanboard.net/screenshots/documentation/calendar.png)

View File

@ -0,0 +1,15 @@
Keyboard shortcuts
==================
Board view
----------
- New task = **n**
- Expand/collapse tasks = **s**
Application
-----------
- Open board switcher = **b**
- Close dialog box = **ESC**
- Submit a form = **CTRL+ENTER** or **⌘+ENTER**

11
docs/link-labels.markdown Normal file
View File

@ -0,0 +1,11 @@
Link settings
=============
Task relations can be changed from the application settings (**Settings > Link settings**)
![Link Labels](http://kanboard.net/screenshots/documentation/link-labels.png)
Each label may have an opposite label defined.
If there is no opposite, the label is considered bi-directionnal.
![Link Label Creation](http://kanboard.net/screenshots/documentation/link-label-creation.png)

22
docs/task-links.markdown Normal file
View File

@ -0,0 +1,22 @@
Task Links
==========
Tasks can be linked together with predefined relationships:
![Task Links](http://kanboard.net/screenshots/documentation/task-links.png)
The default relationships are:
- **relates to**
- **blocks** | is blocked by
- **is blocked by** | blocks
- **duplicates** | is duplicated by
- **is duplicated by** | duplicates
- **is a child of** | is a parent of
- **is a parent of** | is a child of
- **targets milestone** | is a milestone of
- **is a milestone of** | targets milestone
- **fixes** | is fixed by
- **is fixed by** | fixes
Those labels can be changed in the application settings.

View File

@ -0,0 +1,38 @@
Time Tracking
=============
Time tracking information can be defined at the task level or at the subtask level.
Task time tracking
------------------
![Task time tracking](http://kanboard.net/screenshots/documentation/task-time-tracking.png)
Tasks have two fields:
- Time estimated
- Time spent
These values represents hours of work and have to be set manually.
Subtask time tracking
---------------------
![Subtask time tracking](http://kanboard.net/screenshots/documentation/subtask-time-tracking.png)
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
------------------
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.
- 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