diff options
11 files changed, 53 insertions, 27 deletions
diff --git a/server/sonar-docs/src/pages/analysis/overview.md b/server/sonar-docs/src/pages/analysis/overview.md index e02f6425471..d1c21041233 100644 --- a/server/sonar-docs/src/pages/analysis/overview.md +++ b/server/sonar-docs/src/pages/analysis/overview.md @@ -16,11 +16,11 @@ Find the key of your organization, you will need it at later stages. It can be f ## Run analysis SonarCloud currently does not trigger analyses automatically - this feature will come in a near future. Currently, it's up to you to launch them inside your existing CI scripts using the available scanners: -* Gradle - [SonarScanner for Gradle](/scan/sonarscanner-for-gradle/) -* MSBuild - [SonarScanner for MSBuild](/scan/sonarscanner-for-msbuild/) -* Maven - use the [SonarScanner for Maven](/scan/sonarscanner-for-maven/) -* Ant - [SonarScanner for Ant](/scan/sonarscanner-for-ant/) -* anything else (CLI) - [SonarScanner](/scan/sonarscanner/) +* Gradle - [SonarScanner for Gradle](/analysis/scan/sonarscanner-for-gradle/) +* MSBuild - [SonarScanner for MSBuild](/analysis/scan/sonarscanner-for-msbuild/) +* Maven - use the [SonarScanner for Maven](/analysis/scan/sonarscanner-for-maven/) +* Ant - [SonarScanner for Ant](/analysis/scan/sonarscanner-for-ant/) +* anything else (CLI) - [SonarScanner](/analysis/scan/sonarscanner/) After creating a project, the tutorial available on its homepage will guide you to find how to trigger an analysis. @@ -35,13 +35,14 @@ After creating a project, the tutorial available on its homepage will guide you <!-- sonarqube --> Once the SonarQube platform has been installed, you're ready to install a scanner and begin creating projects. To do that, you must install and configure the scanner that is most appropriate for your needs. Do you build with: -* Gradle - [SonarScanner for Gradle](https://redirect.sonarsource.com/doc/gradle.html) -* MSBuild - [SonarScanner for MSBuild](https://redirect.sonarsource.com/doc/install-configure-scanner-msbuild.html) -* Maven - use the [SonarScanner for Maven](https://redirect.sonarsource.com/doc/install-configure-scanner-maven.html) -* Jenkins - [SonarScanner for Jenkins](https://redirect.sonarsource.com/plugins/jenkins.html) -* Azure DevOps - [SonarQube Extension for Azure DevOps](https://redirect.sonarsource.com/doc/install-configure-scanner-tfs-ts.html) -* Ant - [SonarScanner for Ant](https://redirect.sonarsource.com/doc/install-configure-scanner-ant.html) -* anything else (CLI) - [SonarScanner](https://redirect.sonarsource.com/doc/install-configure-scanner.html) +* Gradle - [SonarScanner for Gradle](/analysis/scan/sonarscanner-for-gradle/) +* MSBuild - [SonarScanner for MSBuild](/analysis/scan/sonarscanner-for-msbuild/) +* Maven - use the [SonarScanner for Maven](/analysis/scan/sonarscanner-for-maven/) +* Jenkins - [SonarScanner for Jenkins](/analysis/scan/sonarscanner-for-jenkins/) +* Azure DevOps - [SonarQube Extension for Azure DevOps](/analysis/scan/sonarscanner-for-azure-devops/) +* Ant - [SonarScanner for Ant](/analysis/scan/sonarscanner-for-ant/) +* anything else (CLI) - [SonarScanner](/analysis/scan/sonarscanner/) + **Note** that we do not recommend running an antivirus scanner on the machine where a SonarQube analysis runs, it could result in unpredictable behavior. diff --git a/server/sonar-docs/src/pages/analysis/pull-request.md b/server/sonar-docs/src/pages/analysis/pull-request.md index ca975022e32..925d903b5e5 100644 --- a/server/sonar-docs/src/pages/analysis/pull-request.md +++ b/server/sonar-docs/src/pages/analysis/pull-request.md @@ -49,6 +49,7 @@ Specify your PR provider in your global settings at [**Administration > General ### GitHub <!-- sonarqube -->Enterprise<!-- /sonarqube --> PR Decoration + <!-- sonarqube --> [[info]] | *Minimum GitHub Enterprise version* 2.14 diff --git a/server/sonar-docs/src/pages/scan/sonarscanner-for-ant.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-ant.md index 84d4a2de6fa..8a9b2386cb0 100644 --- a/server/sonar-docs/src/pages/scan/sonarscanner-for-ant.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-ant.md @@ -1,6 +1,6 @@ --- title: SonarScanner for Ant -url: /scan/sonarscanner-for-ant/ +url: /analysis/scan/sonarscanner-for-ant/ --- [[info]] @@ -11,7 +11,7 @@ url: /scan/sonarscanner-for-ant/ The SonarScanner for Ant provides a `task` to allow integration of SonarQube analysis into an Apache Ant build script. -The SonarScanner for Ant is an Ant Task that is wrapper of [SonarScanner](/scan/sonarscanner/), which works by invoking SonarScanner and passing to it all [properties](/analysis/analysis-parameters/) named following a `sonar.*` convention. This has the downside of not being very Ant-y, but the upside of providing instant availability of any new analysis parameter introduced by a new version of a plugin or of SonarQube itself. Therefore, successful use of the SonarScanner for Ant requires strict adherence to the property names shown below. +The SonarScanner for Ant is an Ant Task that is wrapper of [SonarScanner](/analysis/scan/sonarscanner/), which works by invoking SonarScanner and passing to it all [properties](/analysis/analysis-parameters/) named following a `sonar.*` convention. This has the downside of not being very Ant-y, but the upside of providing instant availability of any new analysis parameter introduced by a new version of a plugin or of SonarQube itself. Therefore, successful use of the SonarScanner for Ant requires strict adherence to the property names shown below. ## Use diff --git a/server/sonar-docs/src/pages/scan/sonarscanner-for-azure-devops.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md index cabb21d8306..d4faa54262a 100644 --- a/server/sonar-docs/src/pages/scan/sonarscanner-for-azure-devops.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md @@ -1,11 +1,11 @@ --- title: SonarScanner for Azure DevOps -url: /scan/sonarscanner-for-azure-devops/ +url: /analysis/scan/sonarscanner-for-azure-devops/ --- [[info]] -| By [SonarSource](https://www.sonarsource.com/) – GNU LGPL 3 – [Issue Tracker](https://jira.sonarsource.com/browse/VSTS) – [Source](https://github.com/SonarSource/sonar-scanner-vsts) +| By [SonarSource](https://www.sonarsource.com/) - GNU LGPL 3 - [Issue Tracker](https://jira.sonarsource.com/browse/VSTS) - [Source](https://github.com/SonarSource/sonar-scanner-vsts) | **SonarScanner for Azure DevOps** The <!-- sonarqube -->[SonarQube](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarqube)<!-- /sonarqube --> <!-- sonarcloud -->[SonarCloud](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarcloud)<!-- /sonarcloud --> extension for Azure DevOps <!-- sonarqube -->Server<!-- /sonarqube --> makes it easy to integrate analysis into your build pipeline. The extension allows the analysis of all languages supported by {instance}. @@ -22,7 +22,7 @@ Version <!-- sonarqube -->4.x<!-- /sonarqube --><!-- sonarcloud -->1.x<!-- /sona * Azure DevOps <!-- sonarqube --> -The SonarQube Extension embeds its own version of the [SonarScanner for MSBuild](/scan/sonarscanner-for-msbuild/). +The SonarQube Extension embeds its own version of the [SonarScanner for MSBuild](/analysis/scan/sonarscanner-for-msbuild/). <!-- /sonarqube --> ## Installation diff --git a/server/sonar-docs/src/pages/scan/sonarscanner-for-gradle.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-gradle.md index 73ada0a9a96..457f24aaf11 100644 --- a/server/sonar-docs/src/pages/scan/sonarscanner-for-gradle.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-gradle.md @@ -1,6 +1,6 @@ --- title: SonarScanner for Gradle -url: /scan/sonarscanner-for-gradle/ +url: /analysis/scan/sonarscanner-for-gradle/ --- [[info]] diff --git a/server/sonar-docs/src/pages/scan/sonarscanner-for-jenkins.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-jenkins.md index 5238cc65722..ff05493d89a 100644 --- a/server/sonar-docs/src/pages/scan/sonarscanner-for-jenkins.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-jenkins.md @@ -1,6 +1,6 @@ --- title: SonarScanner for Jenkins -url: /scan/sonarscanner-for-jenkins/ +url: /analysis/scan/sonarscanner-for-jenkins/ --- [[info]] @@ -11,10 +11,10 @@ This plugin lets you centralize the configuration of SonarQube server connection Then you can trigger SonarQube analysis from Jenkins using standard Jenkins Build Steps or [Jenkins Pipeline DSL](https://jenkins.io/solutions/pipeline/) to trigger analysis with: -* [SonarScanner](/scan/sonarscanner/) -* [SonarScanner for Maven](/scan/sonarscanner-for-maven/) -* [SonarScanner for Gradle](/scan/sonarscanner-for-gradle/) -* [SonarScanner for MSBuild](/scan/sonarscanner-for-msbuild/) +* [SonarScanner](/analysis/scan/sonarscanner/) +* [SonarScanner for Maven](/analysis/scan/sonarscanner-for-maven/) +* [SonarScanner for Gradle](/analysis/scan/sonarscanner-for-gradle/) +* [SonarScanner for MSBuild](/analysis/scan/sonarscanner-for-msbuild/) Once the job is complete, the plugin will detect that a SonarQube analysis was made during the build and display a badge and a widget on the job page with a link to the SonarQube dashboard as well as quality gate status. diff --git a/server/sonar-docs/src/pages/scan/sonarscanner-for-maven.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-maven.md index 2a2177a2b40..69cf60094dc 100644 --- a/server/sonar-docs/src/pages/scan/sonarscanner-for-maven.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-maven.md @@ -1,6 +1,6 @@ --- title: SonarScanner for Maven -url: /scan/sonarscanner-for-maven/ +url: /analysis/scan/sonarscanner-for-maven/ --- [[info]] diff --git a/server/sonar-docs/src/pages/scan/sonarscanner-for-msbuild.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-msbuild.md index 8fc233e4a2d..3ba3dea399b 100644 --- a/server/sonar-docs/src/pages/scan/sonarscanner-for-msbuild.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-msbuild.md @@ -1,6 +1,6 @@ --- title: SonarScanner for MSBuild -url: /scan/sonarscanner-for-msbuild/ +url: /analysis/scan/sonarscanner-for-msbuild/ --- [[info]] @@ -14,7 +14,7 @@ url: /scan/sonarscanner-for-msbuild/ The SonarScanner for MSBuild is the recommended way to launch an analysis for projects/solutions using MSBuild or dotnet command as a build tool. It is the result of a [collaboration between SonarSource and Microsoft](http://www.sonarqube.org/announcing-sonarqube-integration-with-msbuild-and-team-build/). -SonarScanner for MSBuild is distributed as a standalone command line executable, as a extension for <!-- sonarcloud -->[Azure DevOps](/scan/sonarscanner-for-azure-devops/)<!-- /sonarcloud --><!-- sonarqube -->[Azure DevOps Server](/scan/sonarscanner-for-azure-devops/)<!-- /sonarqube -->, and as a plugin for [Jenkins](/scan/sonarscanner-for-jenkins/). +SonarScanner for MSBuild is distributed as a standalone command line executable, as a extension for <!-- sonarcloud -->[Azure DevOps](/analysis/scan/sonarscanner-for-azure-devops/)<!-- /sonarcloud --><!-- sonarqube -->[Azure DevOps Server](/analysis/scan/sonarscanner-for-azure-devops/)<!-- /sonarqube -->, and as a plugin for [Jenkins](/analysis/scan/sonarscanner-for-jenkins/). It supports .Net Core multi-platform projects and it can be used on non-Windows platforms. diff --git a/server/sonar-docs/src/pages/scan/sonarscanner.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner.md index a18c4b0552e..251f89bd427 100644 --- a/server/sonar-docs/src/pages/scan/sonarscanner.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner.md @@ -1,6 +1,6 @@ --- title: SonarScanner -url: /scan/sonarscanner/ +url: /analysis/scan/sonarscanner/ --- [[info]] diff --git a/server/sonar-docs/static/SonarQubeNavigationTree.json b/server/sonar-docs/static/SonarQubeNavigationTree.json index dc6bafd000a..fdd64c19c92 100644 --- a/server/sonar-docs/static/SonarQubeNavigationTree.json +++ b/server/sonar-docs/static/SonarQubeNavigationTree.json @@ -10,6 +10,18 @@ "title": "Analyzing Source Code", "children": [ "/analysis/overview/", + { + "title": "Scanners", + "children": [ + "/analysis/scan/sonarscanner-for-gradle/", + "/analysis/scan/sonarscanner-for-msbuild/", + "/analysis/scan/sonarscanner-for-maven/", + "/analysis/scan/sonarscanner-for-azure-devops/", + "/analysis/scan/sonarscanner-for-jenkins/", + "/analysis/scan/sonarscanner-for-ant/", + "/analysis/scan/sonarscanner/" + ] + }, "/analysis/analysis-parameters/", { "title": "Languages", diff --git a/server/sonar-docs/static/StaticNavigationTree.json b/server/sonar-docs/static/StaticNavigationTree.json index d0202b53247..7ce4a20392a 100644 --- a/server/sonar-docs/static/StaticNavigationTree.json +++ b/server/sonar-docs/static/StaticNavigationTree.json @@ -26,6 +26,18 @@ "title": "Analyzing Source Code", "children": [ "/analysis/overview/", + { + "title": "Scanners", + "children": [ + "/analysis/scan/sonarscanner-for-gradle/", + "/analysis/scan/sonarscanner-for-msbuild/", + "/analysis/scan/sonarscanner-for-maven/", + "/analysis/scan/sonarscanner-for-azure-devops/", + "/analysis/scan/sonarscanner-for-jenkins/", + "/analysis/scan/sonarscanner-for-ant/", + "/analysis/scan/sonarscanner/" + ] + }, "/analysis/analysis-parameters/", { "title": "Languages", |