diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/contributing.markdown | 69 | ||||
| -rw-r--r-- | docs/docker.markdown | 48 | ||||
| -rw-r--r-- | docs/kanban-vs-todo-and-scrum.markdown | 37 | ||||
| -rw-r--r-- | docs/what-is-kanban.markdown | 32 |
4 files changed, 186 insertions, 0 deletions
diff --git a/docs/contributing.markdown b/docs/contributing.markdown new file mode 100644 index 00000000..a6b9029c --- /dev/null +++ b/docs/contributing.markdown @@ -0,0 +1,69 @@ +Contributor Guidelines +====================== + +How can I help? +--------------- + +Kanboard is not perfect but there is many ways to help: + +- Give feedback +- Report bugs +- Add or update translations +- Improve the documentation +- Writing code +- Tell your friends that Kanboard is awesome :) + +Before doing any large undertaking, open a new issue and explain your proposal. + +I want to give feedback +----------------------- + +- You think something should be improved (user interface, feature request) +- Check if your idea is not already proposed +- Open a new issue +- Describe your idea +- You can also up vote with +1 on existing proposals + +I want to report a bug +---------------------- + +- Check if the issue is not already reported +- Open a new ticket +- Explain what is broken +- Describe how to reproduce the bug +- Describe your environment (Kanboard version, OS, web server, PHP version, database version, hosting type) + +I want to translate Kanboard +---------------------------- + +Kanboard is translated in many languages. +However, translations are not complete, take look at the [translation guide to contribute](http://kanboard.net/documentation/translations). + +I want to improve the documentation +----------------------------------- + +- You think something is not clear, there is grammatical errors, typo errors, anything. +- The documentation is written in Markdown and stored in the folder `docs`. +- Edit the file and send a pull-request. +- The documentation on the official website is synchronized with the repository. + +I want to contribute to the code +-------------------------------- + +Pull-requests are always welcome, however to be accepted you have to follow those directives: + +- **Before doing any large change or design proposal, open a new ticket to start a discussion.** +- If you want to add a new feature, respect the philosophy behind Kanboard. **We focus on simplicity**, we don't want to have a bloated software. +- The same apply for the user interface, **simplicity and efficiency**. +- Send only one pull-request per feature or bug fix, your patch will be merged into one single commit in the master branch. +- Make sure the [unit tests pass](http://kanboard.net/documentation/tests). +- Respect the [coding standards](http://kanboard.net/documentation/coding-standards). +- Write maintainable code, avoid code duplication, use PHP good practices. + +In any case, if you are not sure about something open a new ticket. + +Tell your friends that Kanboard is awesome :) +--------------------------------------------- + +If you use Kanboard, spread the word around you. +Tell them that free and open source software are cool :) diff --git a/docs/docker.markdown b/docs/docker.markdown new file mode 100644 index 00000000..92fcf2c3 --- /dev/null +++ b/docs/docker.markdown @@ -0,0 +1,48 @@ +How to test Kanboard with Docker? +================================= + +Kanboard can run with [Docker](https://www.docker.com). +You can use the public image or build your own image from the `Dockerfile`. + +Actually, the Docker image is based on the master branch (development version). + +Build your own Docker image +--------------------------- + +From your kanboard directory run the following command: + +```bash +docker build -t youruser\kanboard:master . +``` + +To run your image in background on the port 80: + +```bash +docker run -d --name kanboard -p 80:80 -t youruser/kanboard:master +``` + +Run the public Kanboard image +----------------------------- + +This image is stored on the [Docker Hub](https://hub.docker.com). + +Fetch the image on your machine: + +```bash +docker pull kanboard/kanboard:master +``` + +Run the image: + +```bash +docker run -d --name kanboard -p 80:80 -t kanboard/kanboard:master +``` + +Store your data on a volume +--------------------------- + +You can also save your data outside of the container, on the local machine: + +```bash +docker run -d --name kanboard -v /your/local/data/folder:/var/www/html/data -p 80:80 -t kanboard/kanboard:master +``` diff --git a/docs/kanban-vs-todo-and-scrum.markdown b/docs/kanban-vs-todo-and-scrum.markdown new file mode 100644 index 00000000..3d53023a --- /dev/null +++ b/docs/kanban-vs-todo-and-scrum.markdown @@ -0,0 +1,37 @@ +Kanban vs Todo lists and Scrum +============================== + +Kanban vs Todo lists +-------------------- + +### Todo lists: + +- Single phase (just a list of items) +- Multitasking possible (not efficient) + +### Kanban: + +- Multiple phases, each column represent a step +- Bring focus and avoid multitasking because you can set a work in progress limit per column + +Kanban vs Scrum +--------------- + +### Scrum: + +- Sprints are time-boxed, usually 2 or 4 weeks +- Do not allow changes during the iteration +- Estimation is required +- Uses velocity as default metric +- Scrum board is cleared between each sprint +- Scrum has predefined roles like scrum master, product owner and the team +- A lot of meetings: planning, backlog grooming, daily stand-up, retrospective + +### Kanban: + +- Continuous flow +- Changes can be made at anytime +- Estimation is optional +- Use lead and cycle time to measure performance +- Kanban board is persistent +- Kanban doesn't impose strict constraints or meetings, process is more flexible diff --git a/docs/what-is-kanban.markdown b/docs/what-is-kanban.markdown new file mode 100644 index 00000000..e3c3cf53 --- /dev/null +++ b/docs/what-is-kanban.markdown @@ -0,0 +1,32 @@ +What is Kanban? +=============== + +Kanban is a methodology originally developed by Toyota to be more efficient. + +There is only two constraints imposed by Kanban: + +- Visualize your workflow +- Limit your work in progress + +Visualize your workflow +----------------------- + +- Your work is visualized on a board, you have a clear overview of your project +- Each column represent a step in your workflow + +Bring focus and avoid multitasking +---------------------------------- + +- Each phase can have a work in progress limit +- Limits are great to identify bottlenecks +- Limits avoid working on too many tasks in the same time + +Measure performance and improvement +----------------------------------- + +Kanban uses lead and cycle times to measure performance: + +- **Lead time**: Time between the task is created and completed +- **Cycle time**: Time between the task is started and completed + +By example, you may have a lead time of 100 days and only have to work 1 hour to complete the task. |