Full documentation for SonarQube has moved to a new location: http://docs.sonarqube.org/display/SONAR

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
iconfalse
titleTable of Contents

Table of Contents
maxLevel3

The web interface has been designed to help you quickly find what you are looking for.

It can be displayed in various languages.

Interface Layout

The web interface is divided in three areas:

Top Bar

Wherever you are, you can access the top bar:

  • Dashboards to go back to the Home page
  • Projects to access the complete list of Projects, Views, Developers, etc. or to access previously browsed projects:

      
  • Measures to access the Measures service
  • Issues to access the Issues service
  • Quality Profiles to browse and manage quality profiles
  • Settings to access the system settings (access restricted to System administrators)
  • Log in / <Name> to log in. Depending on your user rights, you will have access to different dashboards and services. Logging in also allows you to have access to your own customized web interface. From there, you can modify your profile and log out.
  • Search for a component: project, file, view, developer, etc. to quickly access it.
     
  • Keep track of where you are thanks to the breadcrumb trail. This breadcrumb trail is clickable, so you can quickly reach an upper level dashboard.
  • <Star> to flag the current project as favorite
  • Configuration to access the current project's configuration pages

Left Menu

The left menu is a contextual menu that depends on the area you are in and on your user rights. It provides access to different dashboards and services.

Data Display

The main kinds of page:

  • Dashboard:
    • Global dashboard displays high level (instance level) data
    • Project dashboard displays project data
  • Component viewer displays detailed data on component
  • Tools and services: issues drilldown, measure service, etc.
  • Configuration pages:
    • System configuration for the system administrators to administer the SonarQube instance
    • Project configuration for the project administrators to configure their project settings (setting analysis properties, creating action plans, etc.)
      Anchor
      drillDown
      drillDown

Drilling Down

The motto is that you will need three clicks maximum to go from a quality indicator to a corrective action in the source code.

Example #1: Issues Drilldown

Example #2: Duplication Drilldown

Quickly Accessing your Favorites

The web interface provides the ability to flag components as favorite. You can then quickly access your favorites by displaying them on dashboards through filters.

Localization

The web interface is displayed in the preferred language that you set in your browser settings.

If it is not, just ask your administrator to add the corresponding language pack. Have a look at the available bundles.