diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api-authentication.markdown | 3 | ||||
| -rw-r--r-- | doc/api-json-rpc.markdown | 1 | ||||
| -rw-r--r-- | doc/fr_FR/index.markdown | 1 | ||||
| -rw-r--r-- | doc/fr_FR/user-mentions.markdown | 13 | ||||
| -rw-r--r-- | doc/plugin-registration.markdown | 22 | ||||
| -rw-r--r-- | doc/screenshots/mention-autocomplete.png | bin | 3066 -> 0 bytes | |||
| -rw-r--r-- | doc/screenshots/user-mentions.png | bin | 0 -> 5228 bytes | |||
| -rw-r--r-- | doc/user-mentions.markdown | 2 |
8 files changed, 40 insertions, 2 deletions
diff --git a/doc/api-authentication.markdown b/doc/api-authentication.markdown index 3ba1e8f5..be536be3 100644 --- a/doc/api-authentication.markdown +++ b/doc/api-authentication.markdown @@ -17,7 +17,8 @@ Default method (HTTP Basic) ### User credentials -- Use the real username and password +- Username: username +- Password: user password or personal access token The API use the [HTTP Basic Authentication Scheme described in the RFC2617](http://www.ietf.org/rfc/rfc2617.txt). diff --git a/doc/api-json-rpc.markdown b/doc/api-json-rpc.markdown index ab1056f0..fc612682 100644 --- a/doc/api-json-rpc.markdown +++ b/doc/api-json-rpc.markdown @@ -18,6 +18,7 @@ There are two types of API access: ### User API - Access to the API with the user credentials (username and password) +- You can also generate a personal access token instead of your password - Application role and project permissions are checked for each procedure - A user session is created on the server - Example of possible clients: native mobile/desktop application, command line utility, etc... diff --git a/doc/fr_FR/index.markdown b/doc/fr_FR/index.markdown index d48c94ca..b33baf85 100644 --- a/doc/fr_FR/index.markdown +++ b/doc/fr_FR/index.markdown @@ -46,6 +46,7 @@ Utiliser Kanboard - [Créer des tâches par email](create-tasks-by-email.markdown) - [Sous-tâches](subtasks.markdown) - [Analytique des tâches](analytics-tasks.markdown) +- [Mentionner les utilisateurs](user-mentions.markdown) ### Travailler avec les utilisateurs diff --git a/doc/fr_FR/user-mentions.markdown b/doc/fr_FR/user-mentions.markdown new file mode 100644 index 00000000..af322bb8 --- /dev/null +++ b/doc/fr_FR/user-mentions.markdown @@ -0,0 +1,13 @@ +Mentionner les utilisateurs +=========================== + +Kanboard offre la possibilité d'envoyer des notifications lorsque quelqu'un est mentionné. + +Si vous avez besoin d'obtenir l'attention de quelqu'un dans un commentaire ou une tâche, utilisez le symbole @ suivi de l'identifiant de l'utilisateur. +Kanboard va automatiquement suggérer une liste d'utilisateurs : + + + +- Pour le moment, cette fonctionnalité est activée uniquement pour la description des tâches et les commentaires +- Cela fonctionne seulement lors de la création des tâches ou commentaires +- Pour être mentionné, les utilisateurs doivent être membres du projet diff --git a/doc/plugin-registration.markdown b/doc/plugin-registration.markdown index a9273e1d..2c80aab3 100644 --- a/doc/plugin-registration.markdown +++ b/doc/plugin-registration.markdown @@ -1,6 +1,28 @@ Plugin Registration =================== +Project skeleton generator +-------------------------- + +You can use `cookiecutter` to create the project structure of your plugin automatically. + +Install Cookiecutter: + +```bash +pip install -U cookiecutter +``` + +Run Kanboard cookiecutter: + +```bash +cookiecutter gh:kanboard/cookiecutter-plugin +plugin_name [My Plugin]: Some Plugin +plugin_namespace [MyPlugin]: SomePlugin +plugin_author [Plugin Author]: Me +plugin_description [My plugin is awesome]: +plugin_homepage [https://github.com/kanboard/plugin-myplugin]: +``` + Directory structure ------------------- diff --git a/doc/screenshots/mention-autocomplete.png b/doc/screenshots/mention-autocomplete.png Binary files differdeleted file mode 100644 index f23fb6d1..00000000 --- a/doc/screenshots/mention-autocomplete.png +++ /dev/null diff --git a/doc/screenshots/user-mentions.png b/doc/screenshots/user-mentions.png Binary files differnew file mode 100644 index 00000000..d5f7bcc6 --- /dev/null +++ b/doc/screenshots/user-mentions.png diff --git a/doc/user-mentions.markdown b/doc/user-mentions.markdown index 156456d6..4ce47054 100644 --- a/doc/user-mentions.markdown +++ b/doc/user-mentions.markdown @@ -6,7 +6,7 @@ Kanboard offers the possibility to send notifications when someone is mentioned. If you need to get the attention of someone in a comment or in a task, use the @ symbol followed by their username. Kanboard will automatically suggest a list of users: - + - At the moment, only the task description and the comment text area have this feature enabled. - The user mentions works only during tasks and comments creation. |
