diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/cli.markdown | 67 | ||||
| -rw-r--r-- | docs/hipchat.markdown | 31 | ||||
| -rw-r--r-- | docs/slack.markdown | 21 |
3 files changed, 93 insertions, 26 deletions
diff --git a/docs/cli.markdown b/docs/cli.markdown index 0e2a0203..b742e0ac 100644 --- a/docs/cli.markdown +++ b/docs/cli.markdown @@ -17,16 +17,16 @@ $ ./kanboard Kanboard version master Usage: - [options] command [arguments] + command [options] [arguments] Options: - --help (-h) Display this help message. - --quiet (-q) Do not output any message. - --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug. - --version (-V) Display this application version. - --ansi Force ANSI output. - --no-ansi Disable ANSI output. - --no-interaction (-n) Do not ask any interactive question. + --help (-h) Display this help message + --quiet (-q) Do not output any message + --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug + --version (-V) Display this application version + --ansi Force ANSI output + --no-ansi Disable ANSI output + --no-interaction (-n) Do not ask any interactive question Available commands: help Displays help for a command @@ -35,6 +35,7 @@ export export:daily-project-summary Daily project summary CSV export (number of tasks per column and per day) export:subtasks Subtasks CSV export export:tasks Tasks CSV export + export:transitions Task transitions CSV export notification notification:overdue-tasks Send notifications for overdue tasks projects @@ -44,6 +45,22 @@ projects Available commands ------------------ +### Tasks CSV export + +Usage: + +```bash +./kanboard export:tasks <project_id> <start_date> <end_date> +``` + +Example: + +```bash +./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +``` + +CSV data are sent to `stdout`. + ### Subtasks CSV export Usage: @@ -58,21 +75,33 @@ Example: ./kanboard export:subtasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` -### Tasks CSV export +### Task transitions CSV export Usage: ```bash -./kanboard export:tasks <project_id> <start_date> <end_date> +./kanboard export:transitions <project_id> <start_date> <end_date> ``` Example: ```bash -./kanboard export:tasks 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +./kanboard export:transitions 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv ``` -CSV data are sent to stdout. +### Export daily summaries data in CSV + +The exported data will be printed on the standard output: + +```bash +./kanboard export:daily-project-summary <project_id> <start_date> <end_date> +``` + +Example: + +```bash +./kanboard export:daily-project-summary 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv +``` ### Send notifications for overdue tasks @@ -111,17 +140,3 @@ Run calculation for Project #0 Run calculation for Project #1 Run calculation for Project #10 ``` - -### Export daily summaries data in CSV - -The exported data will be printed on the standard output: - -```bash -./kanboard export:daily-project-summary <project_id> <start_date> <end_date> -``` - -Example: - -```bash -./kanboard export:daily-project-summary 1 2014-10-01 2014-11-30 > /tmp/my_custom_export.csv -``` diff --git a/docs/hipchat.markdown b/docs/hipchat.markdown new file mode 100644 index 00000000..45d93eb2 --- /dev/null +++ b/docs/hipchat.markdown @@ -0,0 +1,31 @@ +Hipchat integration +=================== + +Send notifications to a room +----------------------------- + +Example of notifications: + + + +This feature use the room notification token system of Hipchat. + +### Hipchat configuration + + + +1. Go to to **My account** +2. Click on the tab **Rooms** and select the room you want to send the notifications +3. On the left, choose **Tokens** +4. Enter a label, by example "Kanboard" and save + +### Kanboard configuration + + + +1. Go to **Settings > Integrations > Hipchat** +2. Replace the API url if you use the self-hosted version of Hipchat +3. Set the room name or the room API ID +4. Copy and paste the token generated previously + +Now, all Kanboard events will be sent to the Hipchat room. diff --git a/docs/slack.markdown b/docs/slack.markdown new file mode 100644 index 00000000..89e3006b --- /dev/null +++ b/docs/slack.markdown @@ -0,0 +1,21 @@ +Slack integration +================= + +Send notifications to a channel +------------------------------- + +Example of notifications: + + + +This feature use the [Incoming webhook](https://api.slack.com/incoming-webhooks) system of Slack. + +### Slack configuration + + + +1. Click on the Team dropdown and choose **Configure Integrations** +2. On the list of services, scroll-down and choose **DIY Integrations & Customizations > Incoming WebHooks** +3. Copy the webhook url to the Kanboard settings page: **Settings > Integrations > Slack** + +Now, all Kanboard events will be sent to the Slack channel. |