Bugtracker, Kanbanflow and documentation to GitHub

The last two weeks a lot of new things appeared on our GitHub account, this is the first part of revisiting the Community & Support section of our website. During the following weeks and months more will chance in this part. In this way we hope to provide better and more clear information to both our users- and developer community.

Documentation

The first thing you will notice is a new repository: Documentation. The goal is to gather all articles and push them to that repo, GitHub makes it easy to maintain the text without writing a complex system ourselves. It is possible to connect certain parts with specific Fork CMS versions, see the complete history of a file, track issues, … The articles themselves are formatted with markdown, when working with a well know open standard it's easy to format the documentation in different ways.

Finally, we will create a module for fork-cms.com that displays the GitHub repository and renders the markdown. In this way non-technical users don't have visit GitHub to explore the documentation.

GitHub Issues

We wanted a complete overview for our development, with every feature or bug in it. One place too see which improvements has to be made. The clearer we make which steps has to be developed, the easier people will engage. That's why we stopped using an external bugtracker and stopped using a (private) agile tool, but started using GitHub issues instead.

Starting new issues is as simple as clicking the New Issue button and describing your comment. By using the right labels you will be able to distinguish bugs from features and Symfony components. It is also recommended to attach code where possible so it's easy for a reviewer to go directly to the code.

We will evaluate the changes along the way, let us know if you have any advice, questions or remarks!

Comments

Wolf wrote 11 years ago

Good ideas. I remember proposing something similar back in the days ;)

You can use Github pages to host a site off of a github repo (using Jekyll to create a static site)