📝 Add SonarQube Article (#176)

An article to help users understand how to integrate Pixeebot with SonarQube issues, in addition to SonarCloud. /closes #work --------- Co-authored-by: David Hafley <[email protected]>
pixee · Jun 10, 2024 · 56c9979 · 56c9979
1 parent 31504a7
commit 56c9979
Show file tree

Hide file tree

Showing 4 changed files with 39 additions and 11 deletions.
diff --git a/docs/code-scanning-tools/codeql.md b/docs/code-scanning-tools/codeql.md
@@ -1,6 +1,6 @@
 ---
 title: "CodeQL"
-sidebar_position: 3
+sidebar_position: 4
 ---
 
 # CodeQL

diff --git a/docs/code-scanning-tools/semgrep.md b/docs/code-scanning-tools/semgrep.md
@@ -1,6 +1,6 @@
 ---
 title: "Semgrep"
-sidebar_position: 2
+sidebar_position: 3
 ---
 
 # Semgrep

diff --git a/docs/code-scanning-tools/sonar.md b/docs/code-scanning-tools/sonar.md
@@ -1,22 +1,26 @@
 ---
-title: "Sonar"
+title: "SonarCloud"
 sidebar_position: 1
 ---
 
-# Sonar
+# SonarCloud
 
-Pixeebot can automatically fix issues detected by [Sonar](https://www.sonarsource.com/products/sonarcloud/). This page explains how to integrate your Sonar results with Pixeebot.
+Pixeebot can automatically fix issues detected by [SonarCloud](https://www.sonarsource.com/products/sonarcloud/). This page explains how to integrate your SonarCloud results with Pixeebot.
+
+:::info
+Looking to fix [SonarQube](https://www.sonarsource.com/products/sonarqube/) issues? See [SonarQube](./sonarqube.md)
+:::
 
 ## How to Get Started
 
-1. Install [pixeebot Github Application](https://github.com/marketplace/pixeebot-automated-code-fixes)
-2. Install [Sonar Github Application](https://github.com/marketplace/sonarcloud)
-3. Add [Upload Tool Results Github Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot)
-4. Start receiving Pull Requests that address Sonar findings.
+1. Install [Pixeebot GitHub Application](https://github.com/marketplace/pixeebot-automated-code-fixes)
+2. Install [Sonar GitHub Application](https://github.com/marketplace/sonarcloud)
+3. Add [Upload Tool Results GitHub Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot)
+4. Start receiving Pull Requests from Pixeebot that address Sonar findings.
 
-## More information
+## More Information
 
-Pixeebot fixes issues detected by Sonar when repositories have both the Pixeebot and Sonar GitHub Apps installed.
+Pixeebot fixes issues detected by SonarCloud when repositories have both the Pixeebot and SonarCloud GitHub Apps installed.
 
 For public repositories using SonarCloud, Pixeebot retrieves results from sonarcloud.io automatically with no further configuration required from the user.
 

diff --git a/docs/code-scanning-tools/sonarqube.md b/docs/code-scanning-tools/sonarqube.md
@@ -0,0 +1,24 @@
+---
+title: "SonarQube"
+sidebar_position: 2
+---
+
+# SonarQube
+
+Pixeebot can automatically fix issues detected by [SonarQube](https://www.sonarsource.com/products/sonarqube/).
+
+For a given Sonar rule, Pixeebot's fixes are the same, regardless of whether the issue was detected by either SonarCloud or SonarQube. However, the steps required to integrate Pixeebot with these systems is different.
+
+## How to Get Started
+
+1. Install [Pixeebot GitHub Application](https://github.com/marketplace/pixeebot-automated-code-fixes)
+2. Add [Upload Tool Results GitHub Action](https://github.com/marketplace/actions/upload-tool-results-to-pixeebot) to workflows that run SonarQube analysis.
+3. Start receiving Pull Requests from Pixeebot that address Sonar findings.
+
+## More Information
+
+Pixee offers an on premises solution that can be deployed alongside your SonarQube instance. Please contact us at [email protected] for detailed setup instructions.
+
+SonarQube Community Edition lacks the features necessary to integrate with Pixeebot's PR experience.
+
+<iframe width="100%" height="315" src="https://www.youtube.com/embed/-Rx5NrZ8zDw?si=B3ktZrOH19fWNLTg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>