Update documentation

This commit is contained in:
Frederic Guillot 2016-03-25 21:47:12 -04:00
parent 3eddaefd76
commit 8f137e6110
36 changed files with 70 additions and 109 deletions

View File

@ -7,7 +7,7 @@ Switching from one view to another can be done with the keyboard shortcut **"s"*
Collapsed mode
--------------
![Tasks collapsed](http://kanboard.net/screenshots/documentation/board-collapsed-mode.png)
![Tasks collapsed](screenshots/board-collapsed-mode.png)
- If the task is assigned to someone, the initials of the person are shown next to the task number
- If the task title is too long, you can put your mouse over the task to show a tooltip with the full title.
@ -15,5 +15,4 @@ Collapsed mode
Expanded mode
-------------
![Tasks expanded](http://kanboard.net/screenshots/documentation/board-expanded-mode.png)
![Tasks expanded](screenshots/board-expanded-mode.png)

View File

@ -5,8 +5,6 @@ When the board cannot fit on your screen, a horizontal scroll bar will appear at
However, it's possible to switch to the compact the view to display all columns in your screen.
![Board in compact mode](http://kanboard.net/screenshots/documentation/board-compact-mode.png)
![Switch to compact mode](screenshots/board-compact-mode.png)
Switching between horizontal scrolling and compact view can be done with the keyboard shortcut **"c"** or by using the drop-down menu on the top left.
Note: It's possible that text overlaps in compact mode, that will be improved over the next releases.

View File

@ -3,9 +3,10 @@ Show and hide columns on the board
You can hide or display columns very easily on the board:
![Board with hidden columns](http://kanboard.net/screenshots/documentation/board-hide-show-column.png)
![Hide a column](screenshots/hide-column.png)
- To hide a column, just click on the column title
- To show a hidden column, click on the vertical title
Pour cacher une colonne, ouvrez le menu déroulant de la colonne.
When a column is hidden, the number of tasks is displayed at the top.
![Show a column](screenshots/show-column.png)
To show again the column, click on the "plus icon".

View File

@ -14,7 +14,7 @@ Creating projects for multiple users
From the dashboard, click on the link **New project**:
![Project creation form](http://kanboard.net/screenshots/documentation/project-creation-form.png)
![Project creation form](screenshots/new-project.png)
It's very easy, you just have to find a name for your project!
@ -27,6 +27,13 @@ Creating a private project
From the dashboard, click on the link **New private project**.
![New private project](http://kanboard.net/screenshots/documentation/new-private-project.png)
Creating projects from another project
--------------------------------------
Note: project names must be unique across the application.
When you create a new project, your can choose to duplicate the properties of another project :
- Permissions
- Actions
- Swimlanes
- Catégories
- Tasks

View File

@ -1,19 +1,18 @@
Mode Replié et Déplié
===========================
Mode replié et déplié
=====================
Les tâches peuvent être affichées sur le tableau en mode replié ou déplié.
Basculer d'un mode à l'autre peut être fait à l'aide du raccourci clavier **« s »** ou en utilisant le menu déroulant sur la gauche.
Les tâches peuvent être affichées sur le Tableau en mode Replié ou Déplié.
Basculer d'un mode à l'autre peut être fait à l'aide du raccourci clavier **"s"** ou en utilisant le menu déroulant sur la gauche.
Mode replié
-----------
Mode Replié
--------------
![Tâches repliées](http://kanboard.net/screenshots/documentation/board-collapsed-mode.png)
![Tâches repliées](screenshots/board-collapsed-mode.png)
- Si la tâche est affectée à quelqu'un, les initiales de la personne sont affichées à côté du numéro de la tâche.
- Si le titre de la tâche est trop long, mettez le curseur de la souris au-dessus de la tâche pour voir une boite flottante avec le titre entier.
Mode Déplié
-------------
![Tâches dépliées](http://kanboard.net/screenshots/documentation/board-expanded-mode.png)
Mode déplié
-----------
![Tâches dépliées](screenshots/board-expanded-mode.png)

View File

@ -1,13 +1,11 @@
Défilement horizontal et mode compact
=====================================
Lorsque le tableau ne tient pas dans votre écran, une barre de défilement horizontal appaîtra au bas de l'écran.
Lorsque le tableau ne loge pas dans votre écran, une barre de défilement horizontal appaîtra en bas de l'écran.
Cependant, il est possible de basculer vers la vue compacte pour afficher toutes les colonnes dans votre écran.
![Tableau en mode compact](http://kanboard.net/screenshots/documentation/board-compact-mode.png)
![Tableau en mode compact](screenshots/board-compact-mode.png)
Basculer entre le défilement horizontal et la vue compacte s'effectue avec le raccourci clavier **"c"** ou en utilisant le menu déroulant sur la gauche.
Note : Il est possible que du texte se superpose dans le mode compact, ceci sera amélioré dans les prochaines versions.
Basculer entre le défilement horizontal et la vue compacte s'effectue avec le raccourci clavier **« c »** ou en utilisant le menu déroulant sur la gauche.

View File

@ -1,12 +1,12 @@
Afficher ou cacher des colonnes dans le tableau
==================================
===============================================
Vous pouvez très facilement cacher ou afficher des colonnes dans le tableau :
![Tableau avec des colonnes cachées](http://kanboard.net/screenshots/documentation/board-hide-show-column.png)
![Cacher une colonne](screenshots/hide-column.png)
- Pour cacher une colonne, cliquez juste sur le titre de la colonne
- Pour afficher une colonne cachée, cliquez sur le titre vertical
Pour cacher une colonne, ouvrez le menu déroulant de la colonne.
Lorsqu'une colonne est cachée, le nombre de tâches est affiché en haut de la colonne.
![Afficher une colonne](screenshots/show-column.png)
Pour afficher de nouveau la colonne, cliquez sur l'icône avec le « plus ».

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

View File

@ -7,26 +7,33 @@ Kanboard peut gérer de multiples projets. Voici deux sortes de projets :
- Les projets privés, réservés à un seul utilisateur
Créer des projets multi-utilisateurs
-------------------------------------
------------------------------------
- Seuls les administrateurs et administrateurs de projets peuvent créer ce type de projets
- Seuls les administrateurs et les gestionnaires de projets peuvent créer ce type de projets
- La gestion des utilisateurs est disponible
Depuis le tableau principal, cliquez sur le lien **Nouveau projet** :
Depuis le tableau de bord, cliquez sur le lien **Nouveau projet** :
![Formulaire de création de projet](captures/kanboard-nouveauprojet.png)
![Formulaire de création de projet](screenshots/new-project.png)
C'est vraiment très simple, il vous suffit de trouver un nom pour votre projet !
Créer un projet privé
--------------------------
---------------------
- Tout le monde peut créer un projet privé
- Tout le monde peut créer un projet privé (sauf si désactivé par l'administrateur)
- Il n'y a **pas** de gestion des utilisateurs
- Seuls le propriétaire et les administrateurs peuvent accéder au projet
Depuis le tableau principal, cliquez sur le lien **Nouveau projet privé**.
![Nouveau projet privé](captures/kanboard-nouveauprojet-prive.png)
Créer un projet depuis un autre projet
--------------------------------------
Remarque : les noms de projets doivent être uniques dans toute l'application.
Lorsque vous créez un nouveau projet, vous pouvez choisir de dupliquer les propriétés d'un projet existant :
- Permissions
- Catégories
- Actions
- Swimlanes
- Tâches

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

View File

@ -1,5 +1,5 @@
Partager des tableaux et des tâches
========================
===================================
Par défaut, les tableaux sont privés, mais il est possible de rendre un tableau public.
@ -15,11 +15,11 @@ Exemples d'utilisation :
- Afficher le tableau sur un grand écran dans votre bureau
Activer l'accès public
-------------------
----------------------
Choisissez votre projet, puis cliquez sur « Accès public » et enfin sur le bouton « Activer l'accès public ».
![Activer l'accès public](captures/kanboard-acces-prive.png)
![Activer l'accès public](screenshots/project-enable-sharing.png)
Lorsque l'accès public est activé, plusieurs liens sont créés :
@ -27,11 +27,9 @@ Lorsque l'accès public est activé, plusieurs liens sont créés :
- Lien de souscription au fil RSS
- Lien d'abonnement à iCalendar
![Désactiver l'accès public](captures/kanboard-acces-public.png)
![Désactiver l'accès public](screenshots/project-disable-sharing.png)
Vous pouvez désactiver l'accès public à tout moment.
À chaque fois que vous activez ou désactivez l'accès public, un nouveau jeton aléatoire est créé.
**Les liens précédents ne fonctionneront pas**.

View File

@ -1,72 +1,26 @@
Gestion des utilisateurs
===============
Rôles au niveau de l'application
------------------------------
Kanboard utilise un système de permissions basique qui reconnaît 3 types d'utilisateurs :
### Administrateur
- Peut accéder à tout
### Administrateur de projets
- Peut créer des projets multi-utilisateurs et privés
- Peut convertir les projets multi-utilisateurs et privés
- Peut voir seulement ses propres projets
- Ne peut pas modifier les paramètres de l'application
- Ne peut pas gérer les utilisateurs
### Utilisateur standard
- Peut créer seulement des projets privés
- Peut voir seulement ses propres projets
- Ne peut pas supprimer de projets
Rôles au niveau des projets
--------------------------
Ces rôles sont liés aux permissions du projet.
### Gestionnaire de projet
- Peut gérer seulement ses propres projets
- Peut accéder aux rapports et à la section budget
### Membre du projet
- Peut pratiquer toutes les opérations quotidiennes sur son projet (créer et déplacer des tâches…)
- Ne peut pas configurer les projets
Remarque : n'importe quel « utilisateur de base » peut être promu « Gestionnaire de projet » pour un projet donné, il n'est pas nécessaire d'être « Administrateur de projets ».
Utilisateurs locaux et distants
----------------------
- Un utilisateur local est un compte qui utilise la base de données pour stocker ses identifiants. Les utilisateurs locaux utilisent le formulaire de connexion pour s'identifier.
- Un utilisateur distant est un compte qui utilise un système externe pour stocker ses identifiants. Par exemple, ce peut être un compte LDAP, Github ou Google. L'authentification de ces utilisateurs peut s'effectuer ou non avec le formulaire de connexion.
========================
Ajouter un nouvel utilisateur
--------------
-----------------------------
Pour ajouter un nouvel utilisateur, vous devez être administrateur.
1. Depuis le tableau de bord, allez au menu **Gestion des utilisateurs**
1. Depuis le menu déroulant situé en haut à droite, cliquez sur **Gestion des utilisateurs**
2. Dans la partie haute vous avez un lien **Créer un utilisateur local** ou **Créer un utilisateur distant**
3. Informez les champs de saisie et enregistrez
![Nouvel utilisateur](captures/kanboard-creer-utilisateur.png)
![Nouvel utilisateur](screenshots/new-user.png)
Quand vous créez un **utilisateur local**, vous devez préciser au moins deux valeurs :
- **nom d'utilisateur** : c'est l'identifiant unique de votre utilisateur (login)
- **mot de passe** : le mot de passe de votre utilisateur doit comporter au moins 6 caractères
Pour les **utilisateurs distants**, seul le nom d'utilisateur est obligatoire. Vous pouvez aussi leur associer leur compte Github ou Google si vous connaissez déjà leur id unique.
Pour les **utilisateurs distants**, seul le nom d'utilisateur est obligatoire.
Modifier des utilisateurs
----------
-------------------------
Quand vous allez au menu **utilisateurs**, vous disposez d'une liste d'utilisateurs. Pour modifier un utilisateur cliquez sur le lien **Modifier**.
@ -74,7 +28,7 @@ Quand vous allez au menu **utilisateurs**, vous disposez d'une liste d'utilisate
- vous devez être administrateur pour pouvoir modifier n'importe quel utilisateur
Supprimer des utilisateurs
------------
--------------------------
Depuis le menu **utilisateurs**, cliquez sur le lien **supprimer**. Ce lien n'est visible que si vous êtes administrateur.

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

View File

@ -15,11 +15,11 @@ Usage examples:
- Display the board on a large screen in your office
Enable public access
-------------------
--------------------
Select your project, then click on "Public access" and finally click on the button "Enable public access".
![Enable public access](http://kanboard.net/screenshots/documentation/project-enable-sharing.png)
![Enable public access](screenshots/project-enable-sharing.png)
When the public access is enabled, a couple of links are generated:
@ -27,7 +27,7 @@ When the public access is enabled, a couple of links are generated:
- RSS feed subscription link
- iCalendar subscription link
![Disable public access](http://kanboard.net/screenshots/documentation/project-disable-sharing.png)
![Disable public access](screenshots/project-disable-sharing.png)
You can also disable the public access whenever you want.

View File

@ -1,4 +1,4 @@
User management
User Management
===============
Add a new user
@ -6,18 +6,18 @@ Add a new user
To add a new user, you must be an administrator.
1. From the dashboard, go to the menu **User Management**
1. From the dropdown menu in the top right corner, go to the menu **Users Management**
2. On the top, you have a link **New local user** or **New remote user**
3. Fill out the form and save
3. Fill the form and save
![New user](http://kanboard.net/screenshots/documentation/new-user.png)
![New user](screenshots/new-user.png)
When you create a **local user**, you have to specify at least those values:
- **username**: This is the unique identifier of your user (login)
- **password**: The password of your user must have at least 6 characters
For **remote users**, only the username is mandatory. You can also pre-link Github or Google accounts if you already know their unique id.
For **remote users**, only the username is mandatory.
Edit users
----------