anuragmishra027/sonar-.net-documentation

Documentation targeting the .Net community explaining how to install and use SonarQube to analyse .Net projects

Introduction

The goal of this documentation is to explain to any member of the .Net community how to install, configure and use the SonarQube ecosystem to analyze .Net projects.

PDF version of the documentation

The pdf for the latest release is available here.

GitBook

The structure of this documentation has been designed to ease the generation of a global PDF file with help of http://www.gitbook.com each time this documentation is released.

Installation Instructions

0. Install NPM (See npmjs.com)
1. Install GitBook with help of the following command line npm install gitbook-cli -g
2. Install Calibre (See http://calibre-ebook.com/download). The ebook-convert command line must be available in the %PATH% (or $PATH). For Mac OS X users, this might be done with help of the following command line sudo ln -s ~/Applications/calibre.app/Contents/MacOS/ebook-convert /usr/bin

Manual actions required when doing a release

0. Edit the 'cover.pptx' file to update the release date and the version
1. Generate a 'cover.jpg' image from 'cover.pptx' and update 'doc/cover.jpg'
2. Execute the following command line from the root directory of the GitHub Repository: gitbook pdf ./doc ./SonarQube-Setup-Guide-For-Net-Users-V-X-Y-Z.pdf