Update documentation
This commit is contained in:
@@ -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
|
Procedures
|
||||||
----------
|
----------
|
||||||
|
|
||||||
|
|||||||
@@ -8,11 +8,13 @@ There are two different views for the calendar:
|
|||||||
|
|
||||||
At this time the calendar is able to display these information:
|
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 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.
|
- 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 time tracking, all recorded time slot will be shown in the calendar.
|
||||||
- Subtask estimates, forecast of work left
|
- Subtask estimates, forecast of work left
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
The calendar configuration can be changed in the settings page.
|
The calendar configuration can be changed in the settings page.
|
||||||
|
|
||||||
|
Note: The due date doesn't contains time information.
|
||||||
|
|||||||
@@ -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 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.
|
You can also rename the `config.default.php` and change the desired values.
|
||||||
|
|
||||||
Enable/Disable debug
|
Enable/Disable debug mode
|
||||||
--------------------
|
-------------------------
|
||||||
|
|
||||||
```php
|
```php
|
||||||
define('DEBUG', false);
|
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
|
Debug file path
|
||||||
---------------
|
---------------
|
||||||
@@ -21,6 +21,7 @@ define('DEBUG_FILE', __DIR__.'/data/debug.log');
|
|||||||
```
|
```
|
||||||
|
|
||||||
All debug information are saved in this file.
|
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
|
Folder for uploaded files
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
Recurring tasks
|
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
|
- Recurring tasks are duplicated to the first column of the board when the selected events occurs
|
||||||
- The due date can be recalculated automatically
|
- 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
|
- Each task records the task id of the parent task that created it and the child task created
|
||||||
|
|||||||
Reference in New Issue
Block a user