Update documentation
This commit is contained in:
@@ -73,10 +73,13 @@ Documentation
|
|||||||
- [Automatic actions](docs/automatic-actions.markdown)
|
- [Automatic actions](docs/automatic-actions.markdown)
|
||||||
- [Project permissions](docs/project-permissions.markdown)
|
- [Project permissions](docs/project-permissions.markdown)
|
||||||
- [Swimlanes](docs/swimlanes.markdown)
|
- [Swimlanes](docs/swimlanes.markdown)
|
||||||
|
- [Calendar](docs/calendar.markdown)
|
||||||
|
|
||||||
#### Working with tasks
|
#### Working with tasks
|
||||||
|
|
||||||
- [Creating tasks](docs/creating-tasks.markdown)
|
- [Creating tasks](docs/creating-tasks.markdown)
|
||||||
|
- [Task links](docs/task-links.markdown)
|
||||||
|
- [Time tracking](docs/time-tracking.markdown)
|
||||||
|
|
||||||
#### Working with users
|
#### Working with users
|
||||||
|
|
||||||
@@ -84,8 +87,10 @@ Documentation
|
|||||||
|
|
||||||
#### Settings
|
#### Settings
|
||||||
|
|
||||||
|
- [Keyboard shortcuts](docs/keyboard-shortcuts.markdown)
|
||||||
- [Application settings](docs/application-configuration.markdown)
|
- [Application settings](docs/application-configuration.markdown)
|
||||||
- [Board settings](docs/board-configuration.markdown)
|
- [Board settings](docs/board-configuration.markdown)
|
||||||
|
- [Link settings](docs/link-labels.markdown)
|
||||||
|
|
||||||
### Integrations
|
### Integrations
|
||||||
|
|
||||||
|
|||||||
@@ -41,3 +41,20 @@ Categories are not global to the application but attached to a project.
|
|||||||
Each project can have different categories.
|
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.
|
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.
|
||||||
|
|||||||
14
docs/calendar.markdown
Normal file
14
docs/calendar.markdown
Normal 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.
|
||||||
|
|
||||||
|

|
||||||
15
docs/keyboard-shortcuts.markdown
Normal file
15
docs/keyboard-shortcuts.markdown
Normal 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
11
docs/link-labels.markdown
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
Link settings
|
||||||
|
=============
|
||||||
|
|
||||||
|
Task relations can be changed from the application settings (**Settings > Link settings**)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Each label may have an opposite label defined.
|
||||||
|
If there is no opposite, the label is considered bi-directionnal.
|
||||||
|
|
||||||
|

|
||||||
22
docs/task-links.markdown
Normal file
22
docs/task-links.markdown
Normal file
@@ -0,0 +1,22 @@
|
|||||||
|
Task Links
|
||||||
|
==========
|
||||||
|
|
||||||
|
Tasks can be linked together with predefined relationships:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
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.
|
||||||
38
docs/time-tracking.markdown
Normal file
38
docs/time-tracking.markdown
Normal 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
|
||||||
|
------------------
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
Tasks have two fields:
|
||||||
|
|
||||||
|
- Time estimated
|
||||||
|
- Time spent
|
||||||
|
|
||||||
|
These values represents hours of work and have to be set manually.
|
||||||
|
|
||||||
|
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
|
||||||
|
------------------
|
||||||
|
|
||||||
|
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
|
||||||
Reference in New Issue
Block a user