summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-05-31 12:40:46 -0400
committerFrederic Guillot <fred@kanboard.net>2015-05-31 12:40:46 -0400
commit0f01bc90de13ba24bd54b33ea5235f32c8453d0a (patch)
tree0f5b5b7ff0628a83f937edaed7a3014b9412455b /docs
parent4f6603e2b16a168712f89ef8b6c242a23938de35 (diff)
Update documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/api-json-rpc.markdown23
-rw-r--r--docs/calendar.markdown6
-rw-r--r--docs/config.markdown7
-rw-r--r--docs/recurring-tasks.markdown2
4 files changed, 33 insertions, 5 deletions
diff --git a/docs/api-json-rpc.markdown b/docs/api-json-rpc.markdown
index 156a552e..929d63fd 100644
--- a/docs/api-json-rpc.markdown
+++ b/docs/api-json-rpc.markdown
@@ -163,6 +163,29 @@ Array
)
```
+### Example with Ruby
+
+This example can be used with Kanboard configured with Reverse-Proxy authentication and the API configured with a custom authentication header:
+
+```ruby
+require 'faraday'
+
+conn = Faraday.new(:url => 'https://kanboard.example.com') do |faraday|
+ faraday.response :logger
+ faraday.headers['X-API-Auth'] = 'XXX' # base64_encode('jsonrpc:API_KEY')
+ faraday.basic_auth(ENV['user'], ENV['pw']) # user/pass to get through basic auth
+ faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
+end
+
+response = conn.post do |req|
+ req.url '/jsonrpc.php'
+ req.headers['Content-Type'] = 'application/json'
+ req.body = '{ "jsonrpc": "2.0", "id": 1, "method": "getAllProjects" }'
+end
+
+puts response.body
+```
+
Procedures
----------
diff --git a/docs/calendar.markdown b/docs/calendar.markdown
index 1dd4a08a..7b95baa2 100644
--- a/docs/calendar.markdown
+++ b/docs/calendar.markdown
@@ -8,11 +8,13 @@ There are two different views for the calendar:
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.
-- Tasks based on the creation date or the start date. These events cannot be modified with the calendar.
+- Tasks with a due date, displayed at the top. **The due date can be changed by moving the task to another day**.
+- Tasks based on the creation date or the start date. **These events cannot be modified with the calendar**.
- Subtask time tracking, all recorded time slot will be shown in the calendar.
- Subtask estimates, forecast of work left
![Calendar](http://kanboard.net/screenshots/documentation/calendar.png)
The calendar configuration can be changed in the settings page.
+
+Note: The due date doesn't contains time information.
diff --git a/docs/config.markdown b/docs/config.markdown
index 34c423c4..081f9c71 100644
--- a/docs/config.markdown
+++ b/docs/config.markdown
@@ -4,14 +4,14 @@ Config file
You can customize the default settings of Kanboard by adding a file `config.php` at the project root.
You can also rename the `config.default.php` and change the desired values.
-Enable/Disable debug
---------------------
+Enable/Disable debug mode
+-------------------------
```php
define('DEBUG', false);
```
-The debug mode log all SQL queries and the time taken to generate pages.
+The debug mode logs all SQL queries and the time taken to generate pages.
Debug file path
---------------
@@ -21,6 +21,7 @@ define('DEBUG_FILE', __DIR__.'/data/debug.log');
```
All debug information are saved in this file.
+If you prefer to send logs to `stdout` or `stderr` replace the value by `php://stdout` or `php://stderr`.
Folder for uploaded files
-------------------------
diff --git a/docs/recurring-tasks.markdown b/docs/recurring-tasks.markdown
index 0253b9b7..b1de8d05 100644
--- a/docs/recurring-tasks.markdown
+++ b/docs/recurring-tasks.markdown
@@ -1,6 +1,8 @@
Recurring tasks
===============
+To fit with the Kanban methodology, the recurring tasks are not based on a date but on board events.
+
- Recurring tasks are duplicated to the first column of the board when the selected events occurs
- The due date can be recalculated automatically
- Each task records the task id of the parent task that created it and the child task created