summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrederic Guillot <fred@kanboard.net>2015-10-07 21:27:29 -0400
committerFrederic Guillot <fred@kanboard.net>2015-10-07 21:27:29 -0400
commitd3e17cec23cb2480eb33ff11beb65ceb0998f968 (patch)
tree40b5337ac2c75fc5a2c7fdd99068fc82a4f53778 /doc
parent9d56525c4b3d63426ab38b9372a659a72a21926c (diff)
Update documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/custom-filters.markdown19
-rw-r--r--doc/fr/notifications.markdown24
-rw-r--r--doc/index.markdown1
-rw-r--r--doc/notifications.markdown31
4 files changed, 67 insertions, 8 deletions
diff --git a/doc/custom-filters.markdown b/doc/custom-filters.markdown
new file mode 100644
index 00000000..18bf8584
--- /dev/null
+++ b/doc/custom-filters.markdown
@@ -0,0 +1,19 @@
+Custom Filters
+==============
+
+Custom filters allow you to save any search query.
+In this way, you can extends easily the default filters and save most used search queries.
+
+- Custom filters are stored by project and associated to the creator.
+- If the creator is project manager, he can choose to share the filter with other project members.
+
+Filter creation
+---------------
+
+Go to the action dropdown or in the project settings and choose **custom filters**:
+
+![Custom Filter Creation](http://kanboard.net/screenshots/documentation/custom-filter-creation.png)
+
+After creating your filter, it will appears on the board next to the default filters:
+
+![Custom Filter Dropdown](http://kanboard.net/screenshots/documentation/custom-filter-dropdown.png)
diff --git a/doc/fr/notifications.markdown b/doc/fr/notifications.markdown
index 05e71bcd..7d85087a 100644
--- a/doc/fr/notifications.markdown
+++ b/doc/fr/notifications.markdown
@@ -11,15 +11,20 @@ Kanboard est capable d'envoyer des notifications via différents canaux :
En fait, pour Jabber/Hipchat/Slack les notifications sont envoyées dans des salons de discussion car ils sont configurés au niveau projet.
Cependant, les notifications par email sont envoyées à un individu.
-Notifications utilisateur
-------------------
+Configuration
+--------------
-Chaque utilisateur doit autoriser les notifications dans son profil : **Profil Utilisateur > Notifications par email**. Cette option est désactivée par défaut.
+Chaque utilisateur doit autoriser les notifications dans son profil : **Profil Utilisateur > Notifications**. Cette option est désactivée par défaut.
Vous devez, bien sûr, avoir renseigné une adresse email valide dans votre profil et l'application doit être configurée pour envoyer des emails.
![Notifications](http://kanboard.net/screenshots/documentation/notifications.png)
+Vous pouvez choisir votre méthode favorite de notification :
+
+- Email
+- Web
+
Pour chaque projet dont vous êtes membre, vous pouvez choisir de recevoir des notifications pour :
- Toutes les tâches
@@ -28,3 +33,16 @@ Pour chaque projet dont vous êtes membre, vous pouvez choisir de recevoir des n
- Seulement les tâches que vous avez créées et celles qui vous sont assignées
Vous pouvez aussi sélectionner certain projets, par défaut tous les projets dont vous êtes membre sont sélectionnés.
+
+Notifications web
+-----------------
+
+Les notifications web sont accéssibles depuis le tableau de bord ou depuis l'icône en haut de la page :
+
+![Icône des notifications web](http://kanboard.net/screenshots/documentation/web-notifications-icon.png)
+
+Les notifications sont affichés sous forme de liste. Vous pouvez marquer comme lu chacune d'entre-elle ou toutes en même temps.
+
+![Notifications web](http://kanboard.net/screenshots/documentation/web-notifications.png)
+
+Avec cette méthode vous pouvez quand même rester avertis de ce que se passe sans pour autant être innonder d'emails.
diff --git a/doc/index.markdown b/doc/index.markdown
index a66cc720..797c8fae 100644
--- a/doc/index.markdown
+++ b/doc/index.markdown
@@ -29,6 +29,7 @@ Using Kanboard
- [Analytics](analytics.markdown)
- [Gantt chart for tasks](gantt-chart-tasks.markdown)
- [Gantt chart for projects](gantt-chart-projects.markdown)
+- [Custom filters](custom-filters.markdown)
### Working with tasks
diff --git a/doc/notifications.markdown b/doc/notifications.markdown
index 39512e77..937060da 100644
--- a/doc/notifications.markdown
+++ b/doc/notifications.markdown
@@ -4,22 +4,29 @@ Notifications
Kanboard is able to send notifications through several channels:
- Email
+- Web
- Jabber/XMPP
- Hipchat
- Slack
Actually, Jabber/Hipchat/Slack notifications are sent to a room or group channel because they are configured at the project level.
-However, email notifications are sent to an individual person.
-User notifications
-------------------
+However, email or web notifications are sent to an individual person.
-Each user must enable the notifications in their profile: **User Profile > Email notifications**. It's disabled by default.
+Configuration
+-------------
-You need of course a valid email address in you profile and the application must be configured to send emails.
+Each user must enable the notifications in their profile: **User Profile > Notifications**. It's disabled by default.
+
+To receive email notifications you need a valid email address in you profile and the application must be configured to send emails.
![Notifications](http://kanboard.net/screenshots/documentation/notifications.png)
+You can choose your favorite notification method:
+
+- Emails
+- Web (see below)
+
For each project your are member, you can choose to receive notifications for:
- All tasks
@@ -28,3 +35,17 @@ For each project your are member, you can choose to receive notifications for:
- Only for tasks created by you and assigned to you
You can also select only some projects, by default it's all projects where you are member.
+
+Web notifications
+-----------------
+
+Web notifications are available from the dashboard or from the icon at the top:
+
+![Web Notifications Icon](http://kanboard.net/screenshots/documentation/web-notifications-icon.png)
+
+Notifications are shown in a list, so you can mark individual notification as read or everything.
+
+![Web Notifications](http://kanboard.net/screenshots/documentation/web-notifications.png)
+
+In this way you can still get notified without having to receive emails.
+