From: michaelbirnstiehl Date: Wed, 1 Apr 2020 19:23:55 +0000 (-0500) Subject: DOCS add importing issues to nav X-Git-Tag: 8.3.0.34182~55 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=08b1e87028ffea85c87ec67e25d8edf113d931a1;p=sonarqube.git DOCS add importing issues to nav --- diff --git a/server/sonar-docs/src/pages/analysis/external-issues.md b/server/sonar-docs/src/pages/analysis/external-issues.md index 8e91299e463..61a4bd6663a 100644 --- a/server/sonar-docs/src/pages/analysis/external-issues.md +++ b/server/sonar-docs/src/pages/analysis/external-issues.md @@ -1,11 +1,11 @@ --- -title: Importing External Issues +title: Importing Third-Party Issues url: /analysis/external-issues/ --- -This page lists analysis parameters related to the import of issues raised by external, third-party analyzers. For more other parameters, see [Analysis Parameters](/analysis/analysis-parameters/). +This page lists analysis parameters related to the import of issues raised by external, third-party analyzers. If your analyzer isn't on this page, see the [Generic Issue Import Format](/analysis/generic-issue/) for a generic way to import external issues. -SonarSource analyzers do not run your external analyzers or generate reports. They only import pre-generated reports. Below you'll find language- and tool-specific analysis parameters for importing reports generated by external analyzers. +SonarSource analyzers do not run your external analyzers or generate reports. They only import pre-generated reports. Below you'll find language- and tool-specific analysis parameters for importing reports generated by external analyzers. In the [Guides](https://community.sonarsource.com/c/announce/guides) category of the [SonarSource Community forum](https://community.sonarsource.com/) you might find instructions on generating these reports. diff --git a/server/sonar-docs/src/pages/analysis/generic-issue.md b/server/sonar-docs/src/pages/analysis/generic-issue.md index 6028d9f16d4..6aa093e9a94 100644 --- a/server/sonar-docs/src/pages/analysis/generic-issue.md +++ b/server/sonar-docs/src/pages/analysis/generic-issue.md @@ -1,14 +1,14 @@ --- -title: Generic Issue Data +title: Generic Issue Import Format url: /analysis/generic-issue/ --- -{instance} supports a generic import format for raising "external" issues in code. It is intended to allow you to import the issues from your favorite linter even if no plugin exists for it. +SonarQube supports a generic import format for raising external issues in code. You can use this format to import issues from your favorite linter even if there's no plugin for it. SonarQube also supports many third-party issue report formats, see [Importing Third-Party Issues](/analysis/external-issues/) for more information. -External issues suffer from two important limitations: +There are a couple of limitations with importing external issues: -* they cannot be managed within {instance}; for instance, there is no ability to mark them False Positive. -* the activation of the rules that raise these issues cannot be managed within {instance}. In fact, external rules are not visible in the Rules page or reflected in any Quality Profile. +* you can't manage them within SonarQube; for instance, there is no ability to mark them False Positive. +* you can't manage the activation of the rules that raise these issues within SonarQube. External rules aren't visible on the Rules page or reflected in Quality Profiles. External issues and the rules that raise them must be managed in the configuration of your linter. diff --git a/server/sonar-docs/static/SonarQubeNavigationTree.json b/server/sonar-docs/static/SonarQubeNavigationTree.json index 98a1b74da88..1753604a17c 100644 --- a/server/sonar-docs/static/SonarQubeNavigationTree.json +++ b/server/sonar-docs/static/SonarQubeNavigationTree.json @@ -55,9 +55,14 @@ ] }, "/analysis/coverage/", - "/analysis/external-issues/", + { + "title": "Importing External Issues", + "children": [ + "/analysis/external-issues/", + "/analysis/generic-issue/" + ] + }, "/analysis/background-tasks/", - "/analysis/generic-issue/", "/analysis/generic-test/", { "title": "Pull Request Analysis", diff --git a/server/sonar-docs/static/StaticNavigationTree.json b/server/sonar-docs/static/StaticNavigationTree.json index 0159cf2672c..95edbd1d488 100644 --- a/server/sonar-docs/static/StaticNavigationTree.json +++ b/server/sonar-docs/static/StaticNavigationTree.json @@ -77,9 +77,14 @@ ] }, "/analysis/coverage/", - "/analysis/external-issues/", + { + "title": "Importing External Issues", + "children": [ + "/analysis/external-issues/", + "/analysis/generic-issue/" + ] + }, "/analysis/background-tasks/", - "/analysis/generic-issue/", "/analysis/generic-test/", { "title": "Pull Request Analysis",