From 95ee805a4c7e0e750acaf2d718ec68a71c7e0892 Mon Sep 17 00:00:00 2001 From: michaelbirnstiehl Date: Wed, 29 Sep 2021 15:42:08 -0500 Subject: [PATCH] SONAR-15462 Document SonarLint Connected Mode with SonarQube --- .../src/pages/user-guide/connected-mode.md | 27 +++++++++++++++++++ .../user-guide/sonarlint-notifications.md | 14 ---------- .../static/SonarCloudNavigationTree.json | 1 - .../static/SonarQubeNavigationTree.json | 2 +- .../static/StaticNavigationTree.json | 2 +- 5 files changed, 29 insertions(+), 17 deletions(-) create mode 100644 server/sonar-docs/src/pages/user-guide/connected-mode.md delete mode 100644 server/sonar-docs/src/pages/user-guide/sonarlint-notifications.md diff --git a/server/sonar-docs/src/pages/user-guide/connected-mode.md b/server/sonar-docs/src/pages/user-guide/connected-mode.md new file mode 100644 index 00000000000..270e0e149e1 --- /dev/null +++ b/server/sonar-docs/src/pages/user-guide/connected-mode.md @@ -0,0 +1,27 @@ +--- +title: SonarLint Connected Mode +url: /user-guide/connected-mode/ +--- +SonarLint Connected Mode connects SonarLint to your SonarQube project and provides additional benefits you won't get by using SonarLint or SonarQube alone. + +**Shared code quality and security expectations** +When using SonarLint alone, the Sonar way Quality Profile is used by default. If you're using a different Quality Profile in SonarQube, new issues may be raised in SonarQube even though your commit looked clean in SonarLint. With Connected Mode, the same customized rule set is applied in both your IDE and in SonarQube, and you're notified in your IDE when your project isn't meeting [Quality Gate](/user-guide/quality-gates/) standards. + +**More security** +When using SonarLint alone, taint analysis issues found by commercial editions of SonarQube aren't raised in SonarLint for performance reasons (we don't want to slow down your editing). In Connected Mode, you'll see the taint analysis issues SonarQube raised in your project. You'll get all of the context in your IDE that you need to triage and fix security problems and make sure the code you commit is safe. + +**Smart Notifications** +Connected mode sends smart alerts to individuals or teams when new issues are discovered. With everyone in the loop, issues can be addressed promptly, improving the overall software quality and delivery. You'll receive Smart Notifications in your IDE when: + +* the [Quality Gate](/user-guide/quality-gates/) status of a project _open in your IDE_ changes +* a SonarQube analysis raises new issues _that you've introduced in a project open in your IDE_ + +You can activate or deactivate Smart Notifications in SonarLint on the IDE side on a server-by-server basis. + +## Setting up Connected Mode +See the following links for instructions on setting up Connected Mode for each supported IDE: + +* [Eclipse](https://github.com/SonarSource/sonarlint-eclipse/wiki/Connected-Mode) +* [IntelliJ IDEA](https://www.sonarlint.org/intellij/#intellij-connected-mode) +* [Visual Studio](https://github.com/SonarSource/sonarlint-visualstudio/wiki/Connected-Mode) +* [VS Code](https://marketplace.visualstudio.com/items?itemName=SonarSource.sonarlint-vscode#connected-mode) \ No newline at end of file diff --git a/server/sonar-docs/src/pages/user-guide/sonarlint-notifications.md b/server/sonar-docs/src/pages/user-guide/sonarlint-notifications.md deleted file mode 100644 index 537c33bbd46..00000000000 --- a/server/sonar-docs/src/pages/user-guide/sonarlint-notifications.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: SonarLint Smart Notifications -url: /user-guide/sonarlint-notifications/ ---- - -Smart notifications allow developers using Connected Mode in SonarLint to receive in-IDE notifications from SonarQube when: - -* the Quality Gate status (failed / success) of a project /solution _open in the IDE_ changes -* a {instance} analysis raises new issues _introduced by this developer in a project /solution open in the IDE_ - -## Activate/deactivate Notifications -The activation or deactivation of notifications must be done individually, by each developer directly in SonarLint (on the IDE side). - -Receiving notifications is configurable on the SonarLint side on a SonarQube server-by-server basis. \ No newline at end of file diff --git a/server/sonar-docs/static/SonarCloudNavigationTree.json b/server/sonar-docs/static/SonarCloudNavigationTree.json index 1068e470de7..3e254a6ddc3 100644 --- a/server/sonar-docs/static/SonarCloudNavigationTree.json +++ b/server/sonar-docs/static/SonarCloudNavigationTree.json @@ -63,7 +63,6 @@ "/user-guide/concepts/", "/user-guide/activity-history/", "/user-guide/visualizations/", - "/user-guide/sonarlint-notifications/", "/user-guide/security-reports/", "/user-guide/user-account/", "/user-guide/user-token/", diff --git a/server/sonar-docs/static/SonarQubeNavigationTree.json b/server/sonar-docs/static/SonarQubeNavigationTree.json index f84c38be252..d3aa87957fc 100644 --- a/server/sonar-docs/static/SonarQubeNavigationTree.json +++ b/server/sonar-docs/static/SonarQubeNavigationTree.json @@ -104,6 +104,7 @@ "children": [ "/user-guide/concepts/", "/user-guide/clean-as-you-code/", + "/user-guide/connected-mode/", "/user-guide/metric-definitions/", "/user-guide/quality-gates/", { @@ -129,7 +130,6 @@ "/user-guide/activity-history/", "/user-guide/project-page/", "/user-guide/visualizations/", - "/user-guide/sonarlint-notifications/", "/user-guide/keyboard-shortcuts/" ] }, diff --git a/server/sonar-docs/static/StaticNavigationTree.json b/server/sonar-docs/static/StaticNavigationTree.json index 846694b0d68..12ce1e53010 100644 --- a/server/sonar-docs/static/StaticNavigationTree.json +++ b/server/sonar-docs/static/StaticNavigationTree.json @@ -138,6 +138,7 @@ "children": [ "/user-guide/concepts/", "/user-guide/clean-as-you-code/", + "/user-guide/connected-mode/", "/user-guide/metric-definitions/", "/user-guide/quality-gates/", { @@ -163,7 +164,6 @@ "/user-guide/activity-history/", "/user-guide/project-page/", "/user-guide/visualizations/", - "/user-guide/sonarlint-notifications/", "/user-guide/keyboard-shortcuts/" ] }, -- 2.39.5