QualInsight / qualinsight-plugins-sonarqube-badges

Plugin for SonarQube that generates badges displaying information about a project's or view's quality.

GNU Lesser General Public License v3.0

110 stars 141 forks source link

Create wiki page for the project #58

Closed pawlakm closed 7 years ago

pawlakm commented 7 years ago

The documentation starts to be difficult to be read to its density. Splitting the README.md file into Wiki pages should improve the readability of the documentation.

Wiki pages:

Introduction
Project Architecture (UML models, design decisions)
Installation
- Compatibility Matrix
Usage
- Quality Gate badges
- Measures badges
- Computer Engine Activity badges
Badges link generator (external link to pages or to www.qualinsight.com)
- Quality Gate badges
- Measures badges
- Computer Engine Activity badges
Known limitations
Contributing
- Guidelines
- Past Contributors
Contact

The README.md file should only contain:

General presentation
Badges (Travis-CI build, SonarQube.com, javadoc)
Link to WIKI documentation