diff options
| author | Frederic Guillot <fred@kanboard.net> | 2015-01-10 12:51:38 -0500 |
|---|---|---|
| committer | Frederic Guillot <fred@kanboard.net> | 2015-01-10 12:51:38 -0500 |
| commit | b470b6726074b3f6b773bf1a28569c39a4cb7db1 (patch) | |
| tree | 369470b735501b4afae370e85ee0fb49bd0fd1eb | |
| parent | 27f1be06f71cee9682779b8f48405e1cf261ee7c (diff) | |
Update docs
| -rw-r--r-- | docs/automatic-actions.markdown | 20 | ||||
| -rw-r--r-- | docs/creating-projects.markdown | 6 | ||||
| -rw-r--r-- | docs/creating-tasks.markdown | 4 | ||||
| -rw-r--r-- | docs/email-configuration.markdown | 12 | ||||
| -rw-r--r-- | docs/github-webhooks.markdown | 2 | ||||
| -rw-r--r-- | docs/gitlab-webhooks.markdown | 2 | ||||
| -rw-r--r-- | docs/swimlanes.markdown | 11 | ||||
| -rw-r--r-- | docs/syntax-guide.markdown | 2 | ||||
| -rw-r--r-- | docs/update.markdown | 2 | ||||
| -rw-r--r-- | docs/user-management.markdown | 13 | ||||
| -rw-r--r-- | docs/what-is-kanban.markdown | 2 |
11 files changed, 42 insertions, 34 deletions
diff --git a/docs/automatic-actions.markdown b/docs/automatic-actions.markdown index cf350a2f..e90a5e5d 100644 --- a/docs/automatic-actions.markdown +++ b/docs/automatic-actions.markdown @@ -9,17 +9,22 @@ Each automatic action is defined like that: - An action linked to this event - Eventually there is some parameters to define -Each project can have a different set of automatic actions, the configuration panel is located on the project listing page, just click on the link "Automatic actions". +Each project can have a different set of automatic actions, the configuration panel is located on the project listing page, just click on the link **Automatic actions**. - +Add a new action +---------------- -To add a new automatic action, choose the event with an action and click on the button "Next Step", then specify action parameters and finish the process by clicking on the button "Save this action". +### Choose an action - + -Each time an event occurs, the corresponding actions are executed. +### Choose an event - + + +### Define action parameters + + List of available events ------------------------ @@ -39,6 +44,9 @@ List of available events - Github issue assignee change - Github issue label change - Github issue comment created +- Gitlab issue opened +- Gitlab issue closed +- Gitlab commit received List of available actions ------------------------- diff --git a/docs/creating-projects.markdown b/docs/creating-projects.markdown index e093e4b4..cf184e1b 100644 --- a/docs/creating-projects.markdown +++ b/docs/creating-projects.markdown @@ -9,12 +9,12 @@ Creating projects for multiple users - Only administrators can create and manage those projects - User management is available -To create a new project, click on the top menu **Projects** and click on the link **New project**. +From the dashboard, click on the link **New project**. Then the form appears:  -It's very easy, you just have to find a name for your project. +It's very easy, you just have to find a name for your project! Creating a private prooject --------------------------- @@ -23,6 +23,6 @@ Creating a private prooject - There is **NO** user management - Only the owner and administrators can access to the project -To create a new private project, click on the top menu **Projects** and click on the link **New private project**. +From the dashboard, click on the link **New private project**. Note: project names must be unique across the application. diff --git a/docs/creating-tasks.markdown b/docs/creating-tasks.markdown index 45a80f04..afcc5ecb 100644 --- a/docs/creating-tasks.markdown +++ b/docs/creating-tasks.markdown @@ -21,5 +21,7 @@ Field description: - **Column**: The column where the task will be created, your task will be positioned at the bottom. - **Color**: Choose the color of the card. - **Complexity**: Used in agile project management (Scrum), the complexity or story points is a number that tells the team how hard the story is. Often, people use the fibonacci series. +- **Original Estimate**: Estimation in hours to complete the tasks. - **Due Date**: Overdue tasks will have a red due date and upcoming due dates will be black on the board. Several date format are accepted in addition to the date picker. -- **Original Estimate**: Estimation in hours to complete the tasks.
\ No newline at end of file + +With the preview link, you can see the task description converted from the Markdown syntax.
\ No newline at end of file diff --git a/docs/email-configuration.markdown b/docs/email-configuration.markdown index 8e0a0a92..6dbc43f9 100644 --- a/docs/email-configuration.markdown +++ b/docs/email-configuration.markdown @@ -40,18 +40,6 @@ It's also possible to use a secure connection, TLS or SSL: define('MAIL_SMTP_ENCRYPTION', 'ssl'); // Valid values are "null", "ssl" or "tls" ``` -Here an example with Google: - -```php -define('MAIL_SMTP_HOSTNAME', 'smtp.gmail.com'); -define('MAIL_SMTP_PORT', 465); -define('MAIL_SMTP_USERNAME', 'my_account@gmail.com'); -define('MAIL_SMTP_PASSWORD', 'my google password'); -define('MAIL_SMTP_ENCRYPTION', 'ssl'); -``` - -To use Google, you might need to allow Kanboard to use your Google account, see ["Allowing less secure apps to access your account"](https://support.google.com/accounts/answer/6010255) and ["My client isn't accepting my username and password"](https://support.google.com/mail/answer/14257). - ### Sendmail configuration By default the sendmail command will be `/usr/sbin/sendmail -bs` but you can customize that in your config file. diff --git a/docs/github-webhooks.markdown b/docs/github-webhooks.markdown index e158c46b..b8e9c3f6 100644 --- a/docs/github-webhooks.markdown +++ b/docs/github-webhooks.markdown @@ -35,7 +35,7 @@ Go to your project settings page, on the left choose "Webhooks & Services", then  -- **Payload url**: This url is available on Kanboard, go to "projects", select your project, at the bottom of the page, you have a section Github webhooks, just copy and paste the link. +- **Payload url**: Copy and paste the link from the Kanboard project settings (section **Integrations > Github**). - Select **"Send me everything"**  diff --git a/docs/gitlab-webhooks.markdown b/docs/gitlab-webhooks.markdown index ae49b914..3369b223 100644 --- a/docs/gitlab-webhooks.markdown +++ b/docs/gitlab-webhooks.markdown @@ -19,7 +19,7 @@ List of supported actions Configuration ------------- -[INSERT SCREENSHOT] + 1. On Kanboard, go to the project settings and choose the section **Integrations** 2. Copy the Gitlab webhook url diff --git a/docs/swimlanes.markdown b/docs/swimlanes.markdown index b899ffc4..25e8b6b9 100644 --- a/docs/swimlanes.markdown +++ b/docs/swimlanes.markdown @@ -4,6 +4,11 @@ Swimlanes Swimlanes are horizontal separations in your board. By example, it's useful to separate software releases, divide your tasks in different products, teams or what ever you want. +Board with swimlanes +-------------------- + + + Managing swimlanes ------------------ @@ -11,14 +16,14 @@ Managing swimlanes - If there is more than one swimlane, the board will show all swimlanes. - You can drag and drop tasks between swimlanes. -To configure swimlanes go to the **project configuration page** and choose the **section Swimlanes**. +To configure swimlanes go to the **project configuration page** and choose the section **Swimlanes**. -[INSERT SCREENSHOT] + From there, you can add a new swimlane or rename the default one. 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. +- **Removing a swimlane doesn't remove tasks assigned to it**, those tasks will be moved to the default swimlane. diff --git a/docs/syntax-guide.markdown b/docs/syntax-guide.markdown index 32430bff..8b1324f0 100644 --- a/docs/syntax-guide.markdown +++ b/docs/syntax-guide.markdown @@ -1,7 +1,7 @@ Syntax Guide ============ -Kanboard use the [Markdown syntax](http://en.wikipedia.org/wiki/Markdown) to write comments or task descriptions. +Kanboard use the [Markdown syntax](http://en.wikipedia.org/wiki/Markdown) for comments or task descriptions. Here are some examples: Bold and italic diff --git a/docs/update.markdown b/docs/update.markdown index cda38bcd..f4564612 100644 --- a/docs/update.markdown +++ b/docs/update.markdown @@ -1,7 +1,7 @@ Update ====== -Important: **Always do a backup of your database before upgrading!** +**Always make a backup of your database before upgrading!** From the archive (stable version) --------------------------------- diff --git a/docs/user-management.markdown b/docs/user-management.markdown index f4809f04..f26afacc 100644 --- a/docs/user-management.markdown +++ b/docs/user-management.markdown @@ -7,19 +7,24 @@ Type of users Kanboard use a basic permission system, there is two kind of users: - Administrators -- Regular/Standard users +- Standard users Administrator have access to everything. By example, they can add or remove projects. -A standard user can't manage users and projects. +There is also permissions defined at the project level, users can be seen as: + +- Project member +- Project manager + +Project managers have more privileges than a simple user member. Add a new user -------------- To add a new user, you must be administrator. -1. Go to the top menu **users** -2. On the left, you have a link **New user** +1. From the dashboard, go to the menu **User Management** +2. On the top, you have a link **New user** 3. Fill the form and save When you create a new user, you have to specify those values: diff --git a/docs/what-is-kanban.markdown b/docs/what-is-kanban.markdown index e3c3cf53..3a37bb7a 100644 --- a/docs/what-is-kanban.markdown +++ b/docs/what-is-kanban.markdown @@ -11,7 +11,7 @@ There is only two constraints imposed by Kanban: Visualize your workflow ----------------------- -- Your work is visualized on a board, you have a clear overview of your project +- Your work is displayed on a board, you have a clear overview of your project - Each column represent a step in your workflow Bring focus and avoid multitasking |