summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/2fa.markdown4
-rw-r--r--doc/faq.markdown9
-rw-r--r--doc/fr_FR/index.markdown2
-rw-r--r--doc/fr_FR/roles.markdown2
-rw-r--r--doc/fr_FR/screenshots/internal-task-links.pngbin0 -> 14772 bytes
-rw-r--r--doc/fr_FR/screenshots/task-transitions.pngbin0 -> 16975 bytes
-rw-r--r--doc/fr_FR/task-links.markdown6
-rw-r--r--doc/fr_FR/transitions.markdown12
-rw-r--r--doc/index.markdown11
-rw-r--r--doc/roles.markdown2
-rw-r--r--doc/screenshots/internal-task-links.pngbin0 -> 9893 bytes
-rw-r--r--doc/screenshots/task-transitions.pngbin0 -> 38420 bytes
-rw-r--r--doc/solving-blank-page-issue.markdown7
-rw-r--r--doc/solving-database-migration-issues.markdown23
-rw-r--r--doc/swimlanes.markdown1
-rw-r--r--doc/task-links.markdown8
-rw-r--r--doc/transitions.markdown12
-rw-r--r--doc/update.markdown9
-rw-r--r--doc/vagrant.markdown2
-rw-r--r--doc/web.config22
-rw-r--r--doc/worker.markdown2
21 files changed, 67 insertions, 67 deletions
diff --git a/doc/2fa.markdown b/doc/2fa.markdown
index 9c02d309..bef256e4 100644
--- a/doc/2fa.markdown
+++ b/doc/2fa.markdown
@@ -4,12 +4,12 @@ Two-Factor Authentication
Each user can enable the [two-factor authentication](http://en.wikipedia.org/wiki/Two_factor_authentication).
After a successful login, a one-time code (6 characters) is asked to the user to allow access to Kanboard.
-This code has to be provided by a compatible software generally installed on your smartphone.
+This code has to be provided by a compatible software usually installed on your smartphone.
Kanboard use the [Time-based One-time Password Algorithm](http://en.wikipedia.org/wiki/Time-based_One-time_Password_Algorithm) defined in the [RFC 6238](http://tools.ietf.org/html/rfc6238).
There are many software compatible with the standard TOTP system.
-For example, you can use these free and open source applications:
+For example, you can use these applications:
- [Google Authenticator](https://github.com/google/google-authenticator/) (Android, iOS, Blackberry)
- [FreeOTP](https://fedorahosted.org/freeotp/) (Android, iOS)
diff --git a/doc/faq.markdown b/doc/faq.markdown
index 76ee07ab..412bbe9b 100644
--- a/doc/faq.markdown
+++ b/doc/faq.markdown
@@ -11,15 +11,6 @@ To have the best performances, choose a provider with fast disk I/O because Kanb
Avoid hosting providers that use a shared NFS mount point.
-I get a blank page after installing or upgrading Kanboard
----------------------------------------------------------
-
-- Check if you have installed all requirements on your server
-- Check the PHP and Apache error logs
-- Check if the files have the correct permission
-- If you use an aggressive OPcode caching, reload your web-server or php-fpm
-
-
I have the error "There is no suitable CSPRNG installed on your system"
-----------------------------------------------------------------------
diff --git a/doc/fr_FR/index.markdown b/doc/fr_FR/index.markdown
index a73c5c23..8f658d78 100644
--- a/doc/fr_FR/index.markdown
+++ b/doc/fr_FR/index.markdown
@@ -38,7 +38,7 @@ Utiliser Kanboard
- [Fermer des tâches](closing-tasks.markdown)
- [Dupliquer et déplacer des tâches](duplicate-move-tasks.markdown)
- [Ajouter des captures d'écran](screenshots.markdown)
-- [Liens entre les tâches](task-links.markdown)
+- [Liens internes entre les tâches](task-links.markdown)
- [Transitions](transitions.markdown)
- [Suivi du temps](time-tracking.markdown)
- [Tâches récurrentes](recurring-tasks.markdown)
diff --git a/doc/fr_FR/roles.markdown b/doc/fr_FR/roles.markdown
index e55a3969..c6a41aa1 100644
--- a/doc/fr_FR/roles.markdown
+++ b/doc/fr_FR/roles.markdown
@@ -22,3 +22,5 @@ Chaque membre d'un projet peut avoir un rôle différent :
| Chef de projet | Peut changer les paramètres du projet, accéder aux rapports |
| Membre du projet | Peut créer des tâches et utiliser le tableau Kanban |
| Visualiseur de projet | Accès en lecture seule au projet |
+
+Il est également possible de créer des rôles personnalisés pour appliquer des restrictions supplémentaires sur les utilisateurs.
diff --git a/doc/fr_FR/screenshots/internal-task-links.png b/doc/fr_FR/screenshots/internal-task-links.png
new file mode 100644
index 00000000..b0aa91ce
--- /dev/null
+++ b/doc/fr_FR/screenshots/internal-task-links.png
Binary files differ
diff --git a/doc/fr_FR/screenshots/task-transitions.png b/doc/fr_FR/screenshots/task-transitions.png
new file mode 100644
index 00000000..b71e82cd
--- /dev/null
+++ b/doc/fr_FR/screenshots/task-transitions.png
Binary files differ
diff --git a/doc/fr_FR/task-links.markdown b/doc/fr_FR/task-links.markdown
index f2756ac7..3f58378f 100644
--- a/doc/fr_FR/task-links.markdown
+++ b/doc/fr_FR/task-links.markdown
@@ -1,9 +1,11 @@
Liens entre les tâches
-==========
+======================
Les tâches peuvent être liées ensemble avec des relations prédéfinies.
-![Task Links](https://kanboard.net/screenshots/documentation/task-links.png)
+![Task Links](screenshots/internal-task-links.png)
+
+Il est également possible de connecter des tâches entre plusieurs projets.
Les relations établies par défaut sont les suivantes :
diff --git a/doc/fr_FR/transitions.markdown b/doc/fr_FR/transitions.markdown
index 94a14bbc..1b7b0879 100644
--- a/doc/fr_FR/transitions.markdown
+++ b/doc/fr_FR/transitions.markdown
@@ -1,20 +1,14 @@
Transitions entre les tâches
-================
+============================
Les transitions enregistrent tous les mouvements des tâches entre les colonnes
-![Transitions](https://kanboard.net/screenshots/documentation/transitions.png)
+![Transitions](screenshots/task-transitions.png)
-Depuis la page des tâches, vous pouvez accéder à ces informations:
+Depuis la page détaillée de la tâche, vous pouvez accéder à ces informations:
- Date de l'action
- Colonne d'origine
- Colonne de destination
- Exécutant (Pour l'utilisateur qui a déplacé la tâche)
- Temps passé sur la colonne d’origine
-
-Les données de transition entre les tâches peuvent aussi être exportées depuis la page des paramètres du projet
-
-![Transitions Export](https://kanboard.net/screenshots/documentation/transitions-export.png)
-
-Pour la période spécifiée, vous allez générer un fichier CSV que vous pouvez utiliser avec n’importe quel tableur
diff --git a/doc/index.markdown b/doc/index.markdown
index b510190d..54010d0c 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -40,7 +40,7 @@ Using Kanboard
- [Closing tasks](closing-tasks.markdown)
- [Duplicate and move tasks](duplicate-move-tasks.markdown)
- [Adding screenshots](screenshots.markdown)
-- [Task links](task-links.markdown)
+- [Internal Task links](task-links.markdown)
- [Transitions](transitions.markdown)
- [Time tracking](time-tracking.markdown)
- [Recurring tasks](recurring-tasks.markdown)
@@ -77,7 +77,7 @@ Using Kanboard
- [Webhooks](webhooks.markdown)
- [Plugins](plugins.markdown)
-### More
+### More information
- [Advanced Search Syntax](search.markdown)
- [Command line interface](cli.markdown)
@@ -85,6 +85,12 @@ Using Kanboard
- [Brute force protection](bruteforce-protection.markdown)
- [Frequently asked questions](faq.markdown)
+### Troubleshooting
+
+- [Solving database migration issues](solving-database-migration-issues.markdown)
+- [Blank page after upgrading](solving-blank-page-issue.markdown)
+- [Performances](performances.markdown)
+
Technical details
-----------------
@@ -108,7 +114,6 @@ Technical details
### Configuration
-- [Performances](performances.markdown)
- [Daily background job](cronjob.markdown)
- [Background Worker](worker.markdown)
- [Config file](config.markdown)
diff --git a/doc/roles.markdown b/doc/roles.markdown
index 181904d5..caa4380d 100644
--- a/doc/roles.markdown
+++ b/doc/roles.markdown
@@ -22,3 +22,5 @@ Each individual team project can assign a different role to each user and group:
| Project Manager | Can change project settings, access to the Gantt chart and reports |
| Project Member | Can create tasks and use the board |
| Project Viewer | Read-only access to the board and tasks |
+
+Custom project roles can be created to apply a set of restrictions to the users.
diff --git a/doc/screenshots/internal-task-links.png b/doc/screenshots/internal-task-links.png
new file mode 100644
index 00000000..97870e92
--- /dev/null
+++ b/doc/screenshots/internal-task-links.png
Binary files differ
diff --git a/doc/screenshots/task-transitions.png b/doc/screenshots/task-transitions.png
new file mode 100644
index 00000000..7665fa59
--- /dev/null
+++ b/doc/screenshots/task-transitions.png
Binary files differ
diff --git a/doc/solving-blank-page-issue.markdown b/doc/solving-blank-page-issue.markdown
new file mode 100644
index 00000000..c24e1f6c
--- /dev/null
+++ b/doc/solving-blank-page-issue.markdown
@@ -0,0 +1,7 @@
+I get a blank page after installing or upgrading Kanboard
+=========================================================
+
+- Check if you have installed all requirements on your server
+- Check the PHP and Apache error logs
+- Check if the files have the correct permissions
+- If you use an aggressive OPcode caching, reload your web-server or php-fpm
diff --git a/doc/solving-database-migration-issues.markdown b/doc/solving-database-migration-issues.markdown
new file mode 100644
index 00000000..ddd39db6
--- /dev/null
+++ b/doc/solving-database-migration-issues.markdown
@@ -0,0 +1,23 @@
+Solving Database Migration Issues
+=================================
+
+- SQL migrations are executed automatically when you upgrade Kanboard to a new version
+- For Postgres and Mysql, the current schema version number is stored in the table `schema_version` and for Sqlite this is stored in the variable `user_version
+- Migrations are defined in the file `app/Schema/<DatabaseType>.php`
+- Each function is a migration
+- Each migration is executed in a transaction
+- If migration generate an error, a rollback is performed
+
+When upgrading:
+
+- Always backup your data
+- Do not run migrations in parallel from multiple processes
+
+If you got the error "Unable to run SQL migrations [...]", here are the steps to fix it manually:
+
+1. Open the file corresponding to your database `app/Schema/Sqlite.php` or `app/Schema/Mysql.php`
+2. Go to the failed migration function
+3. Execute manually the SQL queries defined in the function
+4. If you encounter an error, report the issue to the bug tracker with the exact SQL error
+5. When all SQL statements of the migration are executed, update the schema version number
+6. Run other migrations
diff --git a/doc/swimlanes.markdown b/doc/swimlanes.markdown
index f76336b9..776af138 100644
--- a/doc/swimlanes.markdown
+++ b/doc/swimlanes.markdown
@@ -29,4 +29,3 @@ You can also disable and change the position of the different swimlanes.
- The default swimlane is always on the top but you can hide it.
- Inactive swimlanes are not shown on the board.
- **Removing a swimlane doesn't remove tasks assigned to it**, those tasks will be moved to the default swimlane.
-
diff --git a/doc/task-links.markdown b/doc/task-links.markdown
index cd36ed29..7c8c1add 100644
--- a/doc/task-links.markdown
+++ b/doc/task-links.markdown
@@ -1,9 +1,11 @@
-Task Links
-==========
+Internal Task Links
+===================
Tasks can be linked together with pre-defined relationships:
-![Task Links](https://kanboard.net/screenshots/documentation/task-links.png)
+![Task Links](screenshots/internal-task-links.png)
+
+This is also possible to link tasks across projects.
The default relationships are:
diff --git a/doc/transitions.markdown b/doc/transitions.markdown
index 7b2ad97b..383dfa1d 100644
--- a/doc/transitions.markdown
+++ b/doc/transitions.markdown
@@ -1,9 +1,9 @@
-Task transitions
+Task Transitions
================
-Transitions record each movement of the tasks between columns.
+Each movement of a task between columns is recorded in the database.
-![Transitions](https://kanboard.net/screenshots/documentation/transitions.png)
+![Task Transitions](screenshots/task-transitions.png)
Available from the task view, you can see that information:
@@ -12,9 +12,3 @@ Available from the task view, you can see that information:
- Destination column
- Executor (users that moves the task)
- Time spent in the origin column
-
-Task transition data can also be exported from the project settings page.
-
-![Transitions Export](https://kanboard.net/screenshots/documentation/transitions-export.png)
-
-For the specified time range you will generate a CSV file that you can use with any spreadsheet software.
diff --git a/doc/update.markdown b/doc/update.markdown
index 68e1f587..73269b1e 100644
--- a/doc/update.markdown
+++ b/doc/update.markdown
@@ -1,15 +1,16 @@
Upgrade Kanboard to a new version
=================================
-Upgrading Kanboard to a newer version is seamless.
-The process can be summarized to simply copy your data folder to the new Kanboard folder.
+Most of the time, upgrading Kanboard to a newer version is seamless.
+The process could be summarized to simply copy your data folder to the new Kanboard folder.
Kanboard will run database migrations automatically for you.
Important things to do before updating
--------------------------------------
- **Always make a backup of your data before upgrading**
-- Check that your backup is valid!
+- **Check that your backup is valid!**
+- Check again
- Always read the [change log](https://github.com/kanboard/kanboard/blob/master/ChangeLog) to check for breaking changes
- Always close all user sessions (flush all sessions on the server)
@@ -19,7 +20,7 @@ From the archive (stable version)
1. Decompress the new archive
2. Copy the content of your data folder into the newly uncompressed directory
3. Copy your custom `config.php` if you have one
-4. Copy your plugins if necessary
+4. If you have installed some plugins, use the latest version
5. Make sure the directory `data` is writeable by your web server user
6. Test
7. Remove your old Kanboard directory
diff --git a/doc/vagrant.markdown b/doc/vagrant.markdown
index 864f37b8..8fb05b20 100644
--- a/doc/vagrant.markdown
+++ b/doc/vagrant.markdown
@@ -4,7 +4,7 @@ Run Kanboard with Vagrant
You can try Kanboard with Vagrant very easily:
- Clone the project from the git repository
-- Run `vagrant up`
+- Execute `vagrant up`
- You can access to the application by using the URL `http://localhost:8001/`
The virtual machine is based on Ubuntu 14.04 with PHP 5.5.
diff --git a/doc/web.config b/doc/web.config
deleted file mode 100644
index 1461fe2d..00000000
--- a/doc/web.config
+++ /dev/null
@@ -1,22 +0,0 @@
-<?xml version="1.0"?>
-<configuration>
- <system.webServer>
- <defaultDocument>
- <files>
- <clear />
- <add value="index.php" />
- </files>
- </defaultDocument>
- <rewrite>
- <rules>
- <rule name="Kanboard URL Rewrite" stopProcessing="true">
- <match url="^(.*)$" ignoreCase="false" />
- <conditions logicalGrouping="MatchAll">
- <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" negate="true" />
- </conditions>
- <action type="Rewrite" url="index.php" appendQueryString="true" />
- </rule>
- </rules>
- </rewrite>
- </system.webServer>
-</configuration>
diff --git a/doc/worker.markdown b/doc/worker.markdown
index fba66138..8516068b 100644
--- a/doc/worker.markdown
+++ b/doc/worker.markdown
@@ -32,4 +32,4 @@ This feature is optional and require the installation of a queue daemon on your
### Notes
- You should start the Kanboard worker with a process supervisor (systemd, upstart or supervisord)
-- The process must be have access to the data folder if you store files on the local filesystem and have Sqlite
+- The process must have access to the data folder if you store files on the local filesystem or use Sqlite