Update readme and list of contributors
This commit is contained in:
118
docs/index.markdown
Normal file
118
docs/index.markdown
Normal file
@@ -0,0 +1,118 @@
|
||||
Documentation
|
||||
=============
|
||||
|
||||
Using Kanboard
|
||||
--------------
|
||||
|
||||
### Introduction
|
||||
|
||||
- [What is Kanban?](what-is-kanban.markdown)
|
||||
- [Kanban vs Todo Lists and Scrum](kanban-vs-todo-and-scrum.markdown)
|
||||
- [Usage examples](usage-examples.markdown)
|
||||
|
||||
### Working with projects
|
||||
|
||||
- [Creating projects](creating-projects.markdown)
|
||||
- [Editing projects](editing-projects.markdown)
|
||||
- [Sharing boards and tasks](sharing-projects.markdown)
|
||||
- [Automatic actions](automatic-actions.markdown)
|
||||
- [Project permissions](project-permissions.markdown)
|
||||
- [Swimlanes](swimlanes.markdown)
|
||||
- [Calendar](calendar.markdown)
|
||||
- [Budget](budget.markdown)
|
||||
- [Analytics](analytics.markdown)
|
||||
|
||||
### Working with tasks
|
||||
|
||||
- [Creating tasks](creating-tasks.markdown)
|
||||
- [Adding screenshots](screenshots.markdown)
|
||||
- [Task links](task-links.markdown)
|
||||
- [Transitions](transitions.markdown)
|
||||
- [Time tracking](time-tracking.markdown)
|
||||
- [Recurring tasks](recurring-tasks.markdown)
|
||||
- [Create tasks by email](create-tasks-by-email.markdown)
|
||||
|
||||
### Working with users
|
||||
|
||||
- [User management](user-management.markdown)
|
||||
- [Hourly rate](hourly-rate.markdown)
|
||||
- [Timetable](timetable.markdown)
|
||||
- [Two factor authentication](2fa.markdown)
|
||||
|
||||
### Settings
|
||||
|
||||
- [Keyboard shortcuts](keyboard-shortcuts.markdown)
|
||||
- [Application settings](application-configuration.markdown)
|
||||
- [Project settings](project-configuration.markdown)
|
||||
- [Board settings](board-configuration.markdown)
|
||||
- [Calendar settings](calendar-configuration.markdown)
|
||||
- [Link settings](link-labels.markdown)
|
||||
- [Currency rate](currency-rate.markdown)
|
||||
- [Config file](config.markdown)
|
||||
|
||||
### Integrations
|
||||
|
||||
- [Bitbucket webhooks](bitbucket-webhooks.markdown)
|
||||
- [Github webhooks](github-webhooks.markdown)
|
||||
- [Gitlab webhooks](gitlab-webhooks.markdown)
|
||||
- [Hipchat](hipchat.markdown)
|
||||
- [Jabber](jabber.markdown)
|
||||
- [Mailgun](mailgun.markdown)
|
||||
- [Sendgrid](sendgrid.markdown)
|
||||
- [Slack](slack.markdown)
|
||||
- [Postmark](postmark.markdown)
|
||||
- [iCalendar subscriptions](ical.markdown)
|
||||
- [Json-RPC API](api-json-rpc.markdown)
|
||||
- [Webhooks](webhooks.markdown)
|
||||
|
||||
### More
|
||||
|
||||
- [Command line interface](cli.markdown)
|
||||
- [Syntax guide](syntax-guide.markdown)
|
||||
- [Frequently asked questions](faq.markdown)
|
||||
|
||||
Technical details
|
||||
-----------------
|
||||
|
||||
### Installation
|
||||
|
||||
- [Installation instructions](installation.markdown)
|
||||
- [Upgrade Kanboard to a new version](update.markdown)
|
||||
- [Installation on Ubuntu](ubuntu-installation.markdown)
|
||||
- [Installation on Debian](debian-installation.markdown)
|
||||
- [Installation on Centos](centos-installation.markdown)
|
||||
- [Installation on FreeBSD](freebsd-installation.markdown)
|
||||
- [Installation on Windows Server with IIS](windows-iis-installation.markdown)
|
||||
- [Installation on Windows Server with Apache](windows-apache-installation.markdown)
|
||||
- [Installation on Heroku](heroku.markdown)
|
||||
- [Example with Nginx + HTTPS + SPDY + PHP-FPM](nginx-ssl-php-fpm.markdown)
|
||||
- [Run Kanboard with Docker](docker.markdown)
|
||||
|
||||
### Configuration
|
||||
|
||||
- [Email configuration](email-configuration.markdown)
|
||||
|
||||
### Database
|
||||
|
||||
- [Sqlite database management](sqlite-database.markdown)
|
||||
- [How to use Mysql](mysql-configuration.markdown)
|
||||
- [How to use Postgresql](postgresql-configuration.markdown)
|
||||
|
||||
### Authentication
|
||||
|
||||
- [LDAP authentication](ldap-authentication.markdown)
|
||||
- [Google authentication](google-authentication.markdown)
|
||||
- [GitHub authentication](github-authentication.markdown)
|
||||
- [Reverse proxy authentication](reverse-proxy-authentication.markdown)
|
||||
|
||||
### Contributors
|
||||
|
||||
- [Contributor guide](contributing.markdown)
|
||||
- [Translations](translations.markdown)
|
||||
- [Coding standards](coding-standards.markdown)
|
||||
- [Running tests](tests.markdown)
|
||||
- [Build assets](assets.markdown)
|
||||
- [Run Kanboard with Vagrant](vagrant.markdown)
|
||||
|
||||
The documentation is written in [Markdown](http://en.wikipedia.org/wiki/Markdown).
|
||||
If you want to improve the documentation, just send a pull-request.
|
||||
Reference in New Issue
Block a user