@@ -3,8 +3,6 @@ title: Analysis Parameters | |||
url: /analysis/analysis-parameters/ | |||
--- | |||
## Table of Contents | |||
Parameters to configure project analysis can be set in multiple places. Here is the hierarchy of parameters: | |||
<!-- sonarqube --> |
@@ -3,8 +3,6 @@ title: SCM Integration | |||
url: /analysis/scm-integration/ | |||
--- | |||
## Table of Contents | |||
Collecting SCM data during code analysis can unlock a number of SonarQube features: | |||
* Automatic Issue Assignment |
@@ -7,8 +7,6 @@ url: /branches/overview/ | |||
_Branch analysis is available as part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) and [above](https://www.sonarsource.com/plans-and-pricing/)._ | |||
<!-- /sonarqube --> | |||
## Table of Contents | |||
Branch analysis allows you to | |||
@@ -3,8 +3,6 @@ title: Frequently Asked Questions | |||
url: /faq/ | |||
--- | |||
## Table of Contents | |||
## How do I get rid of issues that are False-Positives? | |||
**False-Positive and Won't Fix** | |||
You can mark individual issues False Positive or Won't Fix through the issues interface. If you're using Short-lived branch and PR analysis provided by the Developer Edition, issues marked False Positive or Won't Fix will retain that status after merge. This is the preferred approach. |
@@ -3,8 +3,6 @@ title: Delegating Authentication | |||
url: /instance-administration/delegated-auth/ | |||
--- | |||
## Table of Contents | |||
SonarQube comes with an onboard user database, as well as the ability to delegate authentication via HTTP Headers, or LDAP. | |||
@@ -3,8 +3,6 @@ title: Marketplace | |||
url: /instance-administration/marketplace/ | |||
--- | |||
## Table of Contents | |||
Administrators can access the Marketplace via **[Administration > Marketplace](/#sonarqube-admin#/admin/marketplace)**. The Marketplace is the place for keeping the pieces of the SonarQube platform up to date. It lets you: | |||
See |
@@ -3,8 +3,6 @@ title: Monitoring | |||
url: /instance-administration/monitoring/ | |||
--- | |||
## Table of Contents | |||
Monitoring your SonarQube instance is key to keeping it healthy and having happy users. | |||
As a start, you can use this Web API to get an overview of the health of your SonarQube installation: |
@@ -5,8 +5,6 @@ url: /instance-administration/project-move/ | |||
_Project Move is available as part of [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/)._ | |||
## Table of Contents | |||
Project Move allows you to export a project from one SonarQube instance and import it into another, identically configured SonarQube instance. To use Project Move, you must have the Administer permission on the project in the source instance, and access to the file systems of both instances. | |||
## When to Use "Project Move" |
@@ -3,8 +3,6 @@ title: Security | |||
url: /instance-administration/security/ | |||
--- | |||
## Table of Contents | |||
## Overview | |||
SonarQube comes with a number of global security features: |
@@ -3,8 +3,6 @@ title: Server Logs & System Info | |||
url: /instance-administration/system-info/ | |||
--- | |||
## Table of Contents | |||
The System Info page is found at **[Administration > System](/#sonarqube-admin#/admin/system)**. It gives you access to detailed information on the state of your SonarQube instance. | |||
## System Info |
@@ -5,8 +5,6 @@ url: /project-administration/configuring-portfolios-and-applications/ | |||
*Portfolios and Applications are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).* | |||
## Table of Contents | |||
## Permissions | |||
Users with the Create Portfolios or Create Applications permission have access to the creation interfaces from the "+" item in the top menu. | |||
@@ -3,8 +3,6 @@ title: Narrowing the Focus | |||
url: /project-administration/narrowing-the-focus/ | |||
--- | |||
## Table of Contents | |||
If {instance}'s results aren't relevant, no one will want to use it. That's why precisely configuring what to analyze for each project is a very important step. Doing so allows you to remove noise, like the issues and duplications marked on generated code, or the issues from rules that aren't relevant for certain types of objects. | |||
{instance} gives you several options for configuring exactly what will be analyzed. You can |
@@ -3,8 +3,6 @@ title: Project Settings | |||
url: /project-administration/project-settings/ | |||
--- | |||
## Table of Contents | |||
## Tags | |||
Project tags allow you to categorize and group projects for easier selection on the **Projects** page. Project tags can be administered from the project home page. Administrators will see a dropdown menu indicator next to the project's list of current tags (or next to the "No tags" indicator). If the tag you want isn't visible in the dropdown, use the built in "search" input to find what you're looking for or create it on the fly. |
@@ -2,8 +2,6 @@ | |||
title: Prerequisites and Overview | |||
url: /requirements/requirements/ | |||
--- | |||
## Table of Contents | |||
## Prerequisite | |||
The only prerequisite for running SonarQube is to have Java (Oracle JRE 8 or OpenJDK 8) installed on your machine. | |||
@@ -7,8 +7,6 @@ _High Availability is a feature of the [Data Center Edition](https://redirect.so | |||
## Table of Contents | |||
Once the the [SonarQube cluster is installed](/setup/install-cluster/), you have a High Availability configuration that will allow your SonarQube instance to stay up and running even if there is a crash or failure in one of the nodes of the cluster. | |||
## Start/Stop/Upgrade the Cluster |
@@ -3,8 +3,6 @@ title: Issues | |||
url: /user-guide/issues/ | |||
--- | |||
## Table of Contents | |||
While running an analysis, {instance} raises an issue every time a piece of code breaks a coding rule. The set of coding rules is defined through the associated [quality profile](/instance-administration/quality-profiles/) for each language in the project. | |||
Each issue has one of five severities: |
@@ -3,8 +3,6 @@ title: Metric Definitions | |||
url: /user-guide/metric-definitions/ | |||
--- | |||
## Table of Contents | |||
## Complexity | |||
**Complexity** (`complexity`) |
@@ -3,8 +3,6 @@ title: Project Page | |||
url: /user-guide/project-page/ | |||
--- | |||
## Table of Contents | |||
The Project Hompepage is the entry point of any project showing: | |||
* the releasability status of the project |
@@ -2,8 +2,6 @@ | |||
title: Rules | |||
url: /user-guide/rules/ | |||
--- | |||
## Table of Contents | |||
## Overview | |||
In {instance}, analyzers contribute rules which are executed on source code to generate issues. There are four types of rules: | |||
* Code Smell (Maintainability domain) |