diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/cloudron.markdown | 28 | ||||
| -rw-r--r-- | doc/fr/keyboard-shortcuts.markdown | 9 | ||||
| -rw-r--r-- | doc/index.markdown | 1 | ||||
| -rw-r--r-- | doc/keyboard-shortcuts.markdown | 9 | ||||
| -rw-r--r-- | doc/plugin-avatar-provider.markdown | 32 | ||||
| -rw-r--r-- | doc/plugin-hooks.markdown | 83 | ||||
| -rw-r--r-- | doc/plugins.markdown | 7 |
7 files changed, 127 insertions, 42 deletions
diff --git a/doc/cloudron.markdown b/doc/cloudron.markdown new file mode 100644 index 00000000..ab6b5bb6 --- /dev/null +++ b/doc/cloudron.markdown @@ -0,0 +1,28 @@ +How to run Kanboard on Cloudron +================================ + +[Cloudron](https://cloudron.io) is a private smartserver on which you can install web +apps like Kanboard. You can install Kanboard into a custom domain and each +installation is backed up and kept up-to-date with Kanboard releases automatically. + +[](https://cloudron.io/button.html?app=net.kanboard.cloudronapp) + +Accounts +-------- + +The app integrates tightly with the Cloudron User Management (via LDAP). Only +Cloudron users can access the Kanboard. In addition, any Cloudron administrator +becomes a Kanboard administrator automatically. + +Installing Plugins +------------------ + +Plugins can be installed and configured using the [Cloudron CLI](https://cloudron.io/references/cli.html) +tool. See the [app description](https://cloudron.io/appstore.html?app=net.kanboard.cloudronapp) for +more information. + +Application Source code +---------------------- + +The source code for the Cloudron app is [here](https://github.com/cloudron-io/kanboard-app). + diff --git a/doc/fr/keyboard-shortcuts.markdown b/doc/fr/keyboard-shortcuts.markdown index 72875896..28a131d8 100644 --- a/doc/fr/keyboard-shortcuts.markdown +++ b/doc/fr/keyboard-shortcuts.markdown @@ -18,9 +18,18 @@ Vue tableau - Étendre / replier une tâche = **s** - Vue compacte / vue étendue = **c** +Vue détaillée d'une tâche +------------------------- + +- Modifier une tâche = **e** +- Nouvelle sous-tâche = **s** +- Nouveau commentaire = **c** +- Nouveau lien interne = **l** + Application ----------- +- Afficher la liste des raccourcis clavier = **?** - Ouvrir le changement de tableau = **b** - Aller au moteur de recherche = **f** - Restaurer la boîte de recherche = **r** diff --git a/doc/index.markdown b/doc/index.markdown index 7a3ca8e5..727f116d 100644 --- a/doc/index.markdown +++ b/doc/index.markdown @@ -100,6 +100,7 @@ Technical details - [Installation on Heroku](heroku.markdown) - [Run Kanboard with Docker](docker.markdown) - [Run Kanboard with Vagrant](vagrant.markdown) +- [Run Kanboard on Cloudron](cloudron.markdown) ### Configuration diff --git a/doc/keyboard-shortcuts.markdown b/doc/keyboard-shortcuts.markdown index beb15d3d..71612415 100644 --- a/doc/keyboard-shortcuts.markdown +++ b/doc/keyboard-shortcuts.markdown @@ -19,9 +19,18 @@ Board view - Expand/collapse tasks = **s** - Compact/wide view = **c** +Task view +--------- + +- Edit task = **e** +- New subtask = **s** +- New comment = **c** +- New internal link = **l** + Application ----------- +- Display list of keyboard shortcuts = **?** - Open board switcher = **b** - Go to the search box = **f** - Reset the search box = **r** diff --git a/doc/plugin-avatar-provider.markdown b/doc/plugin-avatar-provider.markdown new file mode 100644 index 00000000..62941e5c --- /dev/null +++ b/doc/plugin-avatar-provider.markdown @@ -0,0 +1,32 @@ +Adding a new Avatar Provider +============================= + +Registration +------------ + +```php +$this->avatarManager->register(new CustomAvatarProvider()); +``` + +Interface +--------- + +The provider must implements the interface `Kanboard\Core\User\Avatar\AvatarProviderInterface`: + + +| Method | Description | +|-------------------------------|---------------------------------------------------------------| +| `render(array $user, $size)` | Render HTML | +| `isActive(array $user)` | Returns a boolean if the provider is able to render something | + + +The `$user` argument is a dictionary that contains these keys: + +```php +[ + 'id' => 123, + 'username' => 'admin', + 'name' => 'Administrator', + 'email' => 'me@localhost', +] +``` diff --git a/doc/plugin-hooks.markdown b/doc/plugin-hooks.markdown index c1b3e577..9b511c78 100644 --- a/doc/plugin-hooks.markdown +++ b/doc/plugin-hooks.markdown @@ -151,45 +151,50 @@ Template names without prefix are core templates. List of template hooks: -| Hook | Description | -|------------------------------------------|----------------------------------------------------| -| `template:analytic:sidebar` | Sidebar on analytic pages | -| `template:app:filters-helper:before` | Filter helper dropdown (top) | -| `template:app:filters-helper:after` | Filter helper dropdown (bottom) | -| `template:auth:login-form:before` | Login page (top) | -| `template:auth:login-form:after` | Login page (bottom) | -| `template:config:sidebar` | Sidebar on settings page | -| `template:config:application ` | Application settings form | -| `template:config:integrations` | Integration page in global settings | -| `template:dashboard:sidebar` | Sidebar on dashboard page | -| `template:export:sidebar` | Sidebar on export pages | -| `template:layout:head` | Page layout `<head/>` tag | -| `template:layout:top` | Page layout top header | -| `template:layout:bottom` | Page layout footer | -| `template:project:dropdown` | "Actions" menu on left in different project views | -| `template:project:header:before` | Project filters (before) | -| `template:project:header:after` | Project filters (after) | -| `template:project:integrations` | Integration page in projects settings | -| `template:project:sidebar` | Sidebar in project settings | -| `template:project-user:sidebar` | Sidebar on project user overview page | -| `template:task:menu` | "Actions" menu on left in different task views | -| `template:task:dropdown` | Task dropdown menu in listing pages | -| `template:task:sidebar` | Sidebar on task page | -| `template:task:form:right-column` | Right column in task form | -| `template:task:show:top ` | Show task page: top | -| `template:task:show:bottom` | Show task page: bottom | -| `template:task:show:before-description` | Show task page: before description | -| `template:task:show:before-tasklinks` | Show task page: before tasklinks | -| `template:task:show:before-subtasks` | Show task page: before subtasks | -| `template:task:show:before-timetracking` | Show task page: before timetracking | -| `template:task:show:before-attachements` | Show task page: before attachments | -| `template:task:show:before-comments` | Show task page: before comments | -| `template:user:authentication:form` | "Edit authentication" form in user profile | -| `template:user:create-remote:form` | "Create remote user" form | -| `template:user:external` | "External authentication" page in user profile | -| `template:user:integrations` | Integration page in user profile | -| `template:user:sidebar:actions` | Sidebar in user profile (section actions) | -| `template:user:sidebar:information` | Sidebar in user profile (section information) | +| Hook | Description | +|--------------------------------------------|----------------------------------------------------| +| `template:analytic:sidebar` | Sidebar on analytic pages | +| `template:app:filters-helper:before` | Filter helper dropdown (top) | +| `template:app:filters-helper:after` | Filter helper dropdown (bottom) | +| `template:auth:login-form:before` | Login page (top) | +| `template:auth:login-form:after` | Login page (bottom) | +| `template:board:private:task:before-title` | Task in private board: before title | +| `template:board:private:task:after-title` | Task in private board: after title | +| `template:board:public:task:before-title` | Task in public board: before title | +| `template:board:public:task:after-title` | Task in public board: after title | +| `template:board:task:footer` | Task in board: footer | +| `template:config:sidebar` | Sidebar on settings page | +| `template:config:application ` | Application settings form | +| `template:config:integrations` | Integration page in global settings | +| `template:dashboard:sidebar` | Sidebar on dashboard page | +| `template:export:sidebar` | Sidebar on export pages | +| `template:layout:head` | Page layout `<head/>` tag | +| `template:layout:top` | Page layout top header | +| `template:layout:bottom` | Page layout footer | +| `template:project:dropdown` | "Actions" menu on left in different project views | +| `template:project:header:before` | Project filters (before) | +| `template:project:header:after` | Project filters (after) | +| `template:project:integrations` | Integration page in projects settings | +| `template:project:sidebar` | Sidebar in project settings | +| `template:project-user:sidebar` | Sidebar on project user overview page | +| `template:task:menu` | "Actions" menu on left in different task views | +| `template:task:dropdown` | Task dropdown menu in listing pages | +| `template:task:sidebar` | Sidebar on task page | +| `template:task:form:right-column` | Right column in task form | +| `template:task:show:top ` | Show task page: top | +| `template:task:show:bottom` | Show task page: bottom | +| `template:task:show:before-description` | Show task page: before description | +| `template:task:show:before-tasklinks` | Show task page: before tasklinks | +| `template:task:show:before-subtasks` | Show task page: before subtasks | +| `template:task:show:before-timetracking` | Show task page: before timetracking | +| `template:task:show:before-attachements` | Show task page: before attachments | +| `template:task:show:before-comments` | Show task page: before comments | +| `template:user:authentication:form` | "Edit authentication" form in user profile | +| `template:user:create-remote:form` | "Create remote user" form | +| `template:user:external` | "External authentication" page in user profile | +| `template:user:integrations` | Integration page in user profile | +| `template:user:sidebar:actions` | Sidebar in user profile (section actions) | +| `template:user:sidebar:information` | Sidebar in user profile (section information) | Another template hooks can be added if necessary, just ask on the issue tracker. diff --git a/doc/plugins.markdown b/doc/plugins.markdown index e38c887f..475bc249 100644 --- a/doc/plugins.markdown +++ b/doc/plugins.markdown @@ -20,9 +20,10 @@ Plugin creators should specify explicitly the compatible versions of Kanboard. I - [Attach metadata to users, tasks and projects](plugin-metadata.markdown) - [Authentication architecture](plugin-authentication-architecture.markdown) - [Authentication plugin registration](plugin-authentication.markdown) -- [Authorization Architecture](plugin-authorization-architecture.markdown) -- [Custom Group Providers](plugin-group-provider.markdown) -- [External Link Providers](plugin-external-link.markdown) +- [Authorization architecture](plugin-authorization-architecture.markdown) +- [Custom group providers](plugin-group-provider.markdown) +- [External link providers](plugin-external-link.markdown) +- [Add avatar providers](plugin-avatar-provider.markdown) - [LDAP client](plugin-ldap-client.markdown) Examples of plugins |