Update image links in documentation
This commit is contained in:
Frédéric Guillot
@@ -24,7 +24,7 @@ Setup
|
||||
2. On the left, click on **Two factor authentication** and check the box
|
||||
3. A secret key is generated for you
|
||||
|
||||
|
||||
|
||||
|
||||
- You have to save the secret key in your TOTP software. If you use a smartphone, the easiest solution is to scan the QR code with FreeOTP or Google Authenticator.
|
||||
- Each time you will open a new session, a new code will be asked
|
||||
|
||||
@@ -6,7 +6,7 @@ Each task has an analytics section available from the left menu in the task view
|
||||
Lead and cycle time
|
||||
-------------------
|
||||
|
||||
|
||||
|
||||
|
||||
- The lead time is the time between the task creation and the date of completion (task closed).
|
||||
- The cycle time is the time between the start date and the date of completion.
|
||||
@@ -18,7 +18,7 @@ Note: You can configure an automatic action to define the start date automatical
|
||||
Time spent into each column
|
||||
---------------------------
|
||||
|
||||
|
||||
|
||||
|
||||
- This chart shows the total time spent into each column for the task.
|
||||
- The time spent is calculated until the task is closed.
|
||||
|
||||
@@ -6,21 +6,21 @@ Each project have an analytics section. Depending on how you are using Kanboard,
|
||||
User repartition
|
||||
----------------
|
||||
|
||||
|
||||
|
||||
|
||||
This pie chart show the number of open tasks assigned per user.
|
||||
|
||||
Task distribution
|
||||
-----------------
|
||||
|
||||
|
||||
|
||||
|
||||
This pie chart gives an overview of the number of open tasks per column.
|
||||
|
||||
Cumulative flow diagram
|
||||
-----------------------
|
||||
|
||||
|
||||
|
||||
|
||||
- This chart shows the number of tasks cumulatively for each column over the time.
|
||||
- The legend order is the same as the stack in the chart.
|
||||
@@ -33,7 +33,7 @@ Note: You need to have at least two days of data to see the graph.
|
||||
Burn down chart
|
||||
---------------
|
||||
|
||||
|
||||
|
||||
|
||||
The [burn down chart](http://en.wikipedia.org/wiki/Burn_down_chart) is available for each project.
|
||||
|
||||
@@ -44,7 +44,7 @@ The [burn down chart](http://en.wikipedia.org/wiki/Burn_down_chart) is available
|
||||
Average time spent into each column
|
||||
-----------------------------------
|
||||
|
||||
|
||||
|
||||
|
||||
This chart shows the average time spent into each column for the last 1000 tasks.
|
||||
|
||||
@@ -54,7 +54,7 @@ This chart shows the average time spent into each column for the last 1000 tasks
|
||||
Average Lead and Cycle time
|
||||
---------------------------
|
||||
|
||||
|
||||
|
||||
|
||||
This chart show the average lead and cycle time for the last 1000 tasks over time.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ Only administrators can change those settings.
|
||||
|
||||
Go to the menu **Settings**, then choose **Application settings** on the left.
|
||||
|
||||
|
||||
|
||||
|
||||
### Application URL
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ Add a new action
|
||||
|
||||
Click on the link **Add a new automatic action**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Choose an action
|
||||
2. Select an event
|
||||
|
||||
@@ -7,7 +7,7 @@ Switching from one view to another can be done with the keyboard shortcut **"s"*
|
||||
Collapsed mode
|
||||
--------------
|
||||
|
||||
|
||||
|
||||
|
||||
- If the task is assigned to someone, the initials of the person are shown next to the task number.
|
||||
- If the task title is too long, you can put your mouse over the task to show a tooltip with the full title.
|
||||
@@ -15,4 +15,4 @@ Collapsed mode
|
||||
Expanded mode
|
||||
-------------
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ Board settings
|
||||
|
||||
Go to the menu **Settings**, then choose **Board settings** on the left.
|
||||
|
||||
|
||||
|
||||
|
||||
### Task highlighting
|
||||
|
||||
|
||||
@@ -5,6 +5,6 @@ When the board cannot fit on your screen, a horizontal scroll bar will appear at
|
||||
|
||||
However, it's possible to switch to the compact the view to display all columns in your screen.
|
||||
|
||||
|
||||
|
||||
|
||||
Switching between horizontal scrolling and compact view can be done with the keyboard shortcut **"c"** or by using the drop-down menu on the top left.
|
||||
|
||||
@@ -3,10 +3,10 @@ Show and hide columns on the board
|
||||
|
||||
You can hide or display columns very easily on the board:
|
||||
|
||||
|
||||
|
||||
|
||||
To hide a column, click on the column dropdown menu and choose "Hide this column":
|
||||
|
||||
|
||||
|
||||
|
||||
To show the column again, click on the "plus icon".
|
||||
|
||||
@@ -3,7 +3,7 @@ Calendar settings
|
||||
|
||||
Go to the menu **Settings**, then choose **Calendar settings** on the left.
|
||||
|
||||
|
||||
|
||||
|
||||
There are two different calendars in Kanboard:
|
||||
|
||||
|
||||
@@ -13,7 +13,7 @@ At this time the calendar is able to display this information:
|
||||
- Sub-task time tracking, all recorded time slot will be shown in the calendar.
|
||||
- Sub-task estimates, forecasts of work left
|
||||
|
||||
|
||||
|
||||
|
||||
The calendar configuration can be changed in the settings page.
|
||||
|
||||
|
||||
@@ -7,10 +7,10 @@ However, you can always access to the list of closed tasks by using the query **
|
||||
|
||||
There are two different ways to close a task, from the task drop-down menu on the board:
|
||||
|
||||
|
||||
|
||||
|
||||
Or from the task sidebar menu in the task detail view:
|
||||
|
||||
|
||||
|
||||
|
||||
Note: When you close a task, all sub-tasks not completed will be changed to the status "Done".
|
||||
|
||||
@@ -14,7 +14,7 @@ Creating projects for multiple users
|
||||
|
||||
From the dashboard, click on the link **New project**:
|
||||
|
||||
|
||||
|
||||
|
||||
It's very easy: you just have to find a name for your project!
|
||||
|
||||
|
||||
@@ -3,11 +3,11 @@ Creating Tasks
|
||||
|
||||
From the board, click on the plus sign next to the column name:
|
||||
|
||||
|
||||
|
||||
|
||||
Then the task creation form appears:
|
||||
|
||||
|
||||
|
||||
|
||||
Field description:
|
||||
|
||||
|
||||
@@ -6,6 +6,6 @@ If you have to handle multiple currencies, you define here the rate according to
|
||||
|
||||
This feature is used for project budget calculation.
|
||||
|
||||
|
||||
|
||||
|
||||
Currency rate settings are located in **Settings > Currency rates**.
|
||||
|
||||
@@ -12,8 +12,8 @@ Filter creation
|
||||
|
||||
Go to the action drop-down or in the project settings and choose **custom filters**:
|
||||
|
||||
|
||||
|
||||
|
||||
After creating your filter, it will appear on the board next to the default filters:
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -29,7 +29,7 @@ Configuration
|
||||
|
||||
From the project settings, click on the left on the menu **Custom Roles** and at the top of the page click on **Add a new custom role**.
|
||||
|
||||
|
||||
|
||||
|
||||
Give a name to the role and submit the form.
|
||||
|
||||
@@ -43,11 +43,11 @@ There are different kinds of restrictions:
|
||||
|
||||
You can click on the drop-down menu on the table to add a new restriction:
|
||||
|
||||
|
||||
|
||||
|
||||
### 3) List of restrictions
|
||||
|
||||
|
||||
|
||||
|
||||
For example, this role is able to create tasks only in the column "Backlog" and to move tasks between the column "Ready" and "Work in progress".
|
||||
|
||||
@@ -55,34 +55,34 @@ For example, this role is able to create tasks only in the column "Backlog" and
|
||||
|
||||
Go to the "permissions" section on the left menu and assign the desired role to the user.
|
||||
|
||||
|
||||
|
||||
|
||||
Examples
|
||||
--------
|
||||
|
||||
### Allow people to create tasks only in specific columns
|
||||
|
||||
|
||||
|
||||
|
||||
- Users that belong to this role will be able to create new tasks only in the column "Backlog".
|
||||
- The combination of the 2 rules is important, otherwise that will not work.
|
||||
|
||||
### Allow people to change the task status only in specific columns
|
||||
|
||||
|
||||
|
||||
|
||||
- Users that belong to this role will be able to change the task status in the column "Backlog".
|
||||
- Tasks with the status open are visible on the board and tasks with the status closed is hidden by default on the board.
|
||||
|
||||
### Do not allow people to change task status in a specific column
|
||||
|
||||
|
||||
|
||||
|
||||
Users that belong to this role won't be able to change the task status in the column "Done".
|
||||
However, it will be possible in other columns.
|
||||
|
||||
### Allow people to move tasks only between specific columns
|
||||
|
||||
|
||||
|
||||
|
||||
Users that belong to this role will be able to move tasks only between the column "Ready" and "Work in progress".
|
||||
|
||||
@@ -6,7 +6,7 @@ Duplicate a task into the same project
|
||||
|
||||
Go to the task view and choose **Duplicate** on the left.
|
||||
|
||||
|
||||
|
||||
|
||||
A new task will be created with the same properties as the original.
|
||||
|
||||
@@ -15,7 +15,7 @@ Duplicate a task to another project
|
||||
|
||||
Go to the task view and choose **Duplicate to another project**.
|
||||
|
||||
|
||||
|
||||
|
||||
Only projects where you are members will be shown in the drop-down.
|
||||
|
||||
|
||||
@@ -5,7 +5,7 @@ Projects can be renamed or disabled at any time.
|
||||
|
||||
To rename a project, just click on the link entitled "Edit project" on the left.
|
||||
|
||||
|
||||
|
||||
|
||||
- The start date and end date are used to generate the project Gantt chart.
|
||||
- The description is visible as a tooltip on the board and on the projects listing page.
|
||||
|
||||
@@ -8,7 +8,7 @@ The goal of this Gantt chart is to display an overview of all projects based on
|
||||
- Project administrators will see only projects where they are members
|
||||
- Private projects are not shown on this chart
|
||||
|
||||
|
||||
|
||||
|
||||
- The **start date** and the **end date** of projects are used to draw the chart
|
||||
- Horizontal bars can be resized and moved horizontally with your mouse
|
||||
|
||||
@@ -6,7 +6,7 @@ The goal of this Gantt chart is to display a time based overview of the tasks fo
|
||||
- The Gantt chart is available from the "view switcher"
|
||||
- Only project managers can access this section
|
||||
|
||||
|
||||
|
||||
|
||||
- The **start date** and the **due date** of tasks are used to draw the chart
|
||||
- Tasks can be resized and moved horizontally with your mouse
|
||||
@@ -17,4 +17,4 @@ The goal of this Gantt chart is to display a time based overview of the tasks fo
|
||||
- New tasks created from this view will be displayed on the board at the position 1 in the first column
|
||||
- Tasks are displayed in black when there is no start or due date defined
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ Only administrators can create new groups and assign users.
|
||||
Groups can be managed from **User management > View All Groups**.
|
||||
From there, you can create groups and assign users.
|
||||
|
||||
|
||||
|
||||
|
||||
Each project manager can authorize the access to a set of groups from the [project permissions page](project-permissions.markdown).
|
||||
|
||||
|
||||
@@ -30,23 +30,23 @@ Adding your Kanboard calendar to Apple Calendar
|
||||
- Select **File > New Calendar Subscription**
|
||||
- Copy and paste the iCal feed URL from Kanboard
|
||||
|
||||
|
||||
|
||||
|
||||
- You can choose to synchronize the calendar with iCloud to be available across all your devices
|
||||
- Don't forget to select the refresh frequency
|
||||
|
||||
|
||||
|
||||
|
||||
Adding your Kanboard calendar to Microsoft Outlook
|
||||
--------------------------------------------------
|
||||
|
||||
|
||||
|
||||
|
||||
- Open Outlook
|
||||
- Select **Open Calendar > From Internet**
|
||||
- Copy and paste the iCal feed URL from Kanboard
|
||||
|
||||
|
||||
|
||||
|
||||
Adding your Kanboard calendar to Mozilla Thunderbird
|
||||
----------------------------------------------------
|
||||
@@ -55,12 +55,12 @@ Adding your Kanboard calendar to Mozilla Thunderbird
|
||||
- Click on **File > New Calendar**
|
||||
- In the dialog box, choose **On the Network**
|
||||
|
||||
|
||||
|
||||
|
||||
- Choose the format iCalendar
|
||||
- Copy and paste the iCal feed URL from Kanboard
|
||||
|
||||
|
||||
|
||||
|
||||
- Choose the colors and other settings and finally save
|
||||
|
||||
@@ -71,7 +71,7 @@ Adding your Kanboard calendar to Google Calendar
|
||||
- Select **Add by URL** from the menu.
|
||||
- Copy and paste the iCal feed URL from Kanboard
|
||||
|
||||
|
||||
|
||||
|
||||
Your Kanboard calendar can also be available from your Android device if you enable the synchronization.
|
||||
|
||||
|
||||
@@ -3,9 +3,9 @@ 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 bidirectionnal.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -15,7 +15,7 @@ Each user must enable the notifications in their profile: **User Profile > Notif
|
||||
|
||||
To receive email notifications you need a valid email address in your profile and the application must be configured to send emails.
|
||||
|
||||
|
||||
|
||||
|
||||
You can choose your favorite notification method:
|
||||
|
||||
@@ -36,11 +36,11 @@ Web notifications
|
||||
|
||||
Web notifications are available from the dashboard or from the icon at the top:
|
||||
|
||||
|
||||
|
||||
|
||||
Notifications are shown in a list, so you can mark individual notification as read or everything.
|
||||
|
||||
|
||||
|
||||
|
||||
In this way you can still get notified without having to receive emails.
|
||||
|
||||
|
||||
@@ -65,13 +65,13 @@ class Plugin extends Base
|
||||
|
||||
List of merging hooks:
|
||||
|
||||
#### controller:task:form:default
|
||||
`controller:task:form:default`
|
||||
|
||||
- Override default values for task forms
|
||||
- Arguments:
|
||||
- `$default_values`: actual default values (array)
|
||||
|
||||
#### controller:calendar:project:events
|
||||
`controller:calendar:project:events`
|
||||
|
||||
- Add more events to the project calendar
|
||||
- Arguments:
|
||||
@@ -79,7 +79,7 @@ List of merging hooks:
|
||||
- `$start` Calendar start date (string, ISO-8601 format)
|
||||
- `$end` Calendar` end date (string, ISO-8601 format)
|
||||
|
||||
#### controller:calendar:user:events
|
||||
`controller:calendar:user:events`
|
||||
|
||||
- Add more events to the user calendar
|
||||
- Arguments:
|
||||
|
||||
@@ -3,7 +3,7 @@ Project Settings
|
||||
|
||||
Go to the menu **Settings**, then choose **Project settings** on the left.
|
||||
|
||||
|
||||
|
||||
|
||||
### Default columns for new projects
|
||||
|
||||
@@ -27,7 +27,7 @@ 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:
|
||||
|
||||
|
||||
|
||||
|
||||
### Trigger automatically subtask time tracking
|
||||
|
||||
|
||||
@@ -15,6 +15,6 @@ Only administrators have access to everything.
|
||||
|
||||
Role assignments are visible in **Project Settings > Permissions**:
|
||||
|
||||
|
||||
|
||||
|
||||
Private projects cannot define permissions.
|
||||
|
||||
@@ -8,13 +8,13 @@ The search engine uses the [advanced syntax](search.markdown).
|
||||
Board View
|
||||
----------
|
||||
|
||||
|
||||
|
||||
|
||||
- With this view, you can drag and drop tasks between columns easily.
|
||||
- You can also use the keyboard shortcut **"v b"** to switch to the board view.
|
||||
- Tasks with a shadow are recently modified.
|
||||
|
||||
|
||||
|
||||
|
||||
When the task limit is reached for a column, the background becomes red. That means there are too many tasks in progress at the same time.
|
||||
|
||||
@@ -23,7 +23,7 @@ When the task limit is reached for a column, the background becomes red. That me
|
||||
Calendar View
|
||||
--------------
|
||||
|
||||
|
||||
|
||||
|
||||
- With this view, you can visualize tasks with a due date.
|
||||
- Depending of the settings, you can also see tasks in progress.
|
||||
@@ -33,7 +33,7 @@ Calendar View
|
||||
List View
|
||||
---------
|
||||
|
||||
|
||||
|
||||
|
||||
- With this view, all results of your search are displayed in a table.
|
||||
- You can also use the keyboard shortcut **"v l"** to switch to the list view.
|
||||
@@ -41,7 +41,7 @@ List View
|
||||
Gantt View
|
||||
----------
|
||||
|
||||
|
||||
|
||||
|
||||
- The Gantt view displays tasks on a horizontal timeline.
|
||||
- The start date and the due date are used to display the chart.
|
||||
@@ -50,7 +50,7 @@ Gantt View
|
||||
Project Overview
|
||||
----------------
|
||||
|
||||
|
||||
|
||||
|
||||
- View the description of the project.
|
||||
- Attach and upload documents to the project.
|
||||
|
||||
@@ -12,7 +12,7 @@ Configuration
|
||||
|
||||
Go to the task view page or use the drop-down menu on the board, then select **Edit recurrence**.
|
||||
|
||||
|
||||
|
||||
|
||||
There are 3 triggers that currently create a new recurring task:
|
||||
|
||||
|
||||
@@ -5,6 +5,6 @@ To remove a project, you must be the manager of the project or an administrator.
|
||||
|
||||
Go to the **"Project settings"**, and from the menu on the left, at the bottom, choose **"Remove"**.
|
||||
|
||||
|
||||
|
||||
|
||||
Removing a project removes all tasks that belong to this project.
|
||||
|
||||
@@ -13,7 +13,7 @@ Enable/disable project RSS feeds
|
||||
|
||||
Go to **Project settings > Public access**.
|
||||
|
||||
|
||||
|
||||
|
||||
Enable/disable user RSS feeds
|
||||
--------------------------------
|
||||
|
||||
@@ -8,11 +8,11 @@ This is especially useful for taking screenshots to describe an issue for exampl
|
||||
|
||||
You can add screenshots directly from the board by clicking on the dropdown menu or in the task view page.
|
||||
|
||||
|
||||
|
||||
|
||||
To add a new image, take your screenshot and paste with CTRL+V or Command+V:
|
||||
|
||||
|
||||
|
||||
|
||||
On Mac OS X, you can use those shortcuts to take screenshots:
|
||||
|
||||
|
||||
@@ -19,7 +19,7 @@ Enable public access
|
||||
|
||||
Select your project, then click on "Public access" and finally click on the button "Enable public access".
|
||||
|
||||
|
||||
|
||||
|
||||
When public access is enabled, a couple of links are generated:
|
||||
|
||||
@@ -27,7 +27,7 @@ When public access is enabled, a couple of links are generated:
|
||||
- RSS feed subscription link
|
||||
- iCalendar subscription link
|
||||
|
||||
|
||||
|
||||
|
||||
You can also disable public access whenever you want.
|
||||
|
||||
|
||||
@@ -15,22 +15,22 @@ Creating subtasks
|
||||
|
||||
From the task view, on left sidebar click on **Add a subtask**:
|
||||
|
||||
|
||||
|
||||
|
||||
You can also add a subtask quickly 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**.
|
||||
|
||||
|
||||
@@ -7,7 +7,7 @@ For example, it's useful to separate software releases, divide your tasks in dif
|
||||
Board with swimlanes
|
||||
--------------------
|
||||
|
||||
|
||||
|
||||
|
||||
- You can collapse swimlanes by clicking on the icon on the left
|
||||
- The default swimlane is always shown at the top
|
||||
@@ -21,7 +21,7 @@ Managing swimlanes
|
||||
|
||||
To configure swimlanes go to the **project configuration page** and choose the section **Swimlanes**.
|
||||
|
||||
|
||||
|
||||
|
||||
From there, you can add a new swimlane or rename the default one.
|
||||
You can also disable and change the position of the different swimlanes.
|
||||
|
||||
@@ -4,25 +4,25 @@ Tags
|
||||
With Kanboard, you can associate one or many tags to a task.
|
||||
You can define tags globally for all projects or only for a specific project.
|
||||
|
||||
|
||||
|
||||
|
||||
From the task form, you can enter the desired tags:
|
||||
|
||||
|
||||
|
||||
|
||||
The auto-completion form will show up to suggest available tags.
|
||||
|
||||
You can also create tags directly from the task form.
|
||||
By default, when you create tags from a task form they are associated to the current project:
|
||||
|
||||
|
||||
|
||||
|
||||
All tags can be managed in the project settings.
|
||||
|
||||
To define tags globally for all projects, go to the application settings:
|
||||
|
||||
|
||||
|
||||
|
||||
To search tasks based on tags, just use the attribute "tag":
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ Internal Task Links
|
||||
|
||||
Tasks can be linked together with pre-defined relationships:
|
||||
|
||||
|
||||
|
||||
|
||||
This is also possible to link tasks across projects.
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ Time tracking information can be defined at the task level or at the subtask lev
|
||||
Task time tracking
|
||||
------------------
|
||||
|
||||
|
||||
|
||||
|
||||
Tasks have two fields:
|
||||
|
||||
@@ -18,7 +18,7 @@ These values represent hours of work and have to be set manually.
|
||||
Subtask time tracking
|
||||
---------------------
|
||||
|
||||
|
||||
|
||||
|
||||
Subtasks also have the fields "time spent" and "time estimated".
|
||||
|
||||
@@ -31,11 +31,11 @@ Kanboard records the time between each subtask status change in a separate table
|
||||
|
||||
The breakdown of all records is visible in the task view page:
|
||||
|
||||
|
||||
|
||||
|
||||
For each subtask, the timer can be stopped/started at any time:
|
||||
|
||||
|
||||
|
||||
|
||||
- The timer doesn't depend of the subtask status
|
||||
- Each time you start the timer a new record is created in the time tracking table
|
||||
|
||||
@@ -3,7 +3,7 @@ Task Transitions
|
||||
|
||||
Each movement of a task between columns is recorded in the database.
|
||||
|
||||
|
||||
|
||||
|
||||
Available from the task view, you can see that information:
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ To add a new user, you must be an administrator.
|
||||
2. On the top, you have a link **New local user** or **New remote user**
|
||||
3. Fill the form and save
|
||||
|
||||
|
||||
|
||||
|
||||
When you create a **local user**, you have to specify at least those values:
|
||||
|
||||
|
||||
@@ -6,7 +6,7 @@ Kanboard offers the possibility to send notifications when someone is mentioned.
|
||||
If you need to get the attention of someone in a comment or in a task, use the @ symbol followed by their username.
|
||||
Kanboard will automatically suggest a list of users:
|
||||
|
||||
|
||||
|
||||
|
||||
- At the moment, only the task description and the comment text area have this feature enabled.
|
||||
- The user mentions works only during tasks and comments creation.
|
||||
|
||||
Reference in New Issue
Block a user