Skip to content

Commit

Permalink
SLVSCODE-912 update docs links to match rebranding
Browse files Browse the repository at this point in the history
  • Loading branch information
sophio-japharidze-sonarsource committed Nov 27, 2024
1 parent c6712a3 commit ee2192d
Show file tree
Hide file tree
Showing 10 changed files with 27 additions and 27 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ SonarQube for IDE by [Sonar](https://www.sonarsource.com/) is a free IDE extensi
Out of the box, SonarQube for IDE: Visual Studio Code supports analysis of JS/TS, Python, PHP, Java, C, C++, C#, Go, and IaC code locally in your IDE.

By default, SonarQube for IDE analyzes files **open** in the IDE. When paired with SonarQube ([Server](https://www.sonarsource.com/products/sonarqube/), [Cloud](https://www.sonarsource.com/products/sonarcloud/)) in Connected Mode, SonarQube for IDE forms a powerful end-to-end code quality platform to enrich the CI/CD pipeline, ensuring any code edits or additions **across the whole project** are clean.
In Connected Mode, your team can share common language rulesets, project analysis settings and [more](https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode/).
In Connected Mode, your team can share common language rulesets, project analysis settings and [more](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode/).

<a href='https://www.youtube.com/watch?v=Ks4Slmzb1qY' target='_blank'><img alt='What is SonarQube for IDE video' src='images/what_is_sonarlint.png'></a>

Check the [SonarQube for IDE: VS Code documentation](https://docs.sonarsource.com/sonarlint/vs-code/) for the most up-to-date requirements, installation instructions, and feature details.
Check the [SonarQube for IDE: VS Code documentation](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/) for the most up-to-date requirements, installation instructions, and feature details.

Sonar's [Clean Code solutions](https://www.sonarsource.com/solutions/clean-code/) help developers deliver high-quality, efficient code standards that benefit the entire team or organization.

Expand Down Expand Up @@ -49,7 +49,7 @@ Out of the box, SonarQube for IDE: VS Code automatically checks your code agains
- [Terraform rules](https://rules.sonarsource.com/terraform)
- [TypeScript rules](https://rules.sonarsource.com/typescript)

The full list of supported languages and rules is available in [our docs](https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/rules/).
The full list of supported languages and rules is available in [our docs](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/rules/).

## Requirements

Expand Down Expand Up @@ -98,7 +98,7 @@ Analysis of TypeScript in Connected Mode with SonarQube requires the server to u

### C and C++ analysis specific requirements

To analyze C and C++ code, SonarQube for IDE: VS Code requires [compile commands json file](https://docs.sonarsource.com/sonarlint/vs-code/getting-started/running-an-analysis/#analyze-c-and-cpp-code):
To analyze C and C++ code, SonarQube for IDE: VS Code requires [compile commands json file](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/getting-started/running-an-analysis/#analyze-c-and-cpp-code):

```json
{
Expand Down Expand Up @@ -126,21 +126,21 @@ The support for COBOL analysis is only available together with SonarQube Server

### Jupyter notebooks

SonarQube for IDE: VS Code supports analysis of Python code inside Jupyter notebooks. See the [documentation](https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/scan-my-project/#jupyter-notebooks) page for details.
SonarQube for IDE: VS Code supports analysis of Python code inside Jupyter notebooks. See the [documentation](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/scan-my-project/#jupyter-notebooks) page for details.

### Injection vulnerabilities specific requirements

Security vulnerabilities requiring taint engine analysis (taint vulnerabilities) are only available in Connected Mode because SonarQube for IDE pulls them from SonarQube (Server, Cloud) following a project analysis.

To browse injection vulnerabilities in SonarQube for IDE: VS Code, establish [Connected Mode](https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode/) with your SonarQube Server Developer Edition (and above) or SonarQube Cloud instance. Once a [Project Binding](https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode-setup/#project-binding) is configured, SonarQube for IDE will synchronize with the SonarQube (Server, Cloud) to report the detected injection vulnerabilities.
To browse injection vulnerabilities in SonarQube for IDE: VS Code, establish [Connected Mode](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode/) with your SonarQube Server Developer Edition (and above) or SonarQube Cloud instance. Once a [Project Binding](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode-setup/#project-binding) is configured, SonarQube for IDE will synchronize with the SonarQube (Server, Cloud) to report the detected injection vulnerabilities.

More information about security-related rules is available in the SonarQube ([Server](https://docs.sonarqube.org/latest/user-guide/security-rules/), [Cloud](https://docs.sonarcloud.io/digging-deeper/security-related-rules/)) documentation.
More information about security-related rules is available in the SonarQube ([Server](https://docs.sonarsource.com/sonarqube-server/latest/user-guide/rules/security-related-rules/), [Cloud](https://docs.sonarcloud.io/digging-deeper/security-related-rules/)) documentation.

### Security Hotspots in SonarQube for IDE: VS Code

Local detection of [Security Hotspots](https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/security-hotspots/) is enabled if you are using [Connected Mode](https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode/) with SonarQube Server 9.9 or above, or SonarQube Cloud.
Local detection of [Security Hotspots](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/security-hotspots/) is enabled if you are using [Connected Mode](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode/) with SonarQube Server 9.9 or above, or SonarQube Cloud.

Please see the [documentation](https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/security-hotspots/) for more details.
Please see the [documentation](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/security-hotspots/) for more details.

### Secrets detection

Expand All @@ -152,7 +152,7 @@ You can connect SonarQube for IDE to [SonarQube Server](https://www.sonarsource.

While in Connected Mode, SonarQube for IDE receives notifications from SonarQube (Server, Cloud) about your Quality Gate changes and new issues. Notifications can be enabled or disabled from the UI while creating or editing the connection settings.

When running in Connected Mode, and browsing a [Security Hotspot](https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/security-hotspots/), a button will be available offering to open the hotspot in SonarQube for IDE (with SonarQube for IDE already running in VSCode). Limitation: this feature relies on local communication between your web browser and SonarQube for IDE, and consequently is not available in some remote environments such as GitPod, or GitHub CodeSpaces.
When running in Connected Mode, and browsing a [Security Hotspot](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/security-hotspots/), a button will be available offering to open the hotspot in SonarQube for IDE (with SonarQube for IDE already running in VSCode). Limitation: this feature relies on local communication between your web browser and SonarQube for IDE, and consequently is not available in some remote environments such as GitPod, or GitHub CodeSpaces.

Connected Mode will also unlock your analysis of these languages:

Expand All @@ -161,7 +161,7 @@ Connected Mode will also unlock your analysis of these languages:
- [PL/SQL rules](https://rules.sonarsource.com/plsql)
- [T-SQL rules](https://rules.sonarsource.com/tsql/)

When configuring Connected Mode, follow the [Connection Setup instructions](https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode-setup/#connection-setup).
When configuring Connected Mode, follow the [Connection Setup instructions](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode-setup/#connection-setup).

## Other settings

Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
"type": "array",
"scope": "application",
"default": [],
"markdownDescription": "Connect SonarQube for VS Code to SonarQube Server to apply the same Clean Code standards as your team. Analyze more languages, detect more issues **on the whole project**, receive notifications about the quality gate status, and more. Quality Profiles and file exclusion settings defined on the server are shared between all connected users. Please find the documentation [here](https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode/)",
"markdownDescription": "Connect SonarQube for VS Code to SonarQube Server to apply the same Clean Code standards as your team. Analyze more languages, detect more issues **on the whole project**, receive notifications about the quality gate status, and more. Quality Profiles and file exclusion settings defined on the server are shared between all connected users. Please find the documentation [here](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode/)",
"items": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -147,7 +147,7 @@
"type": "array",
"scope": "application",
"default": [],
"markdownDescription": "Connect SonarQube for VS Code to SonarQube Cloud to apply the same Clean Code standards as your team. Analyze more languages, detect more issues **on the whole project**, receive notifications about the quality gate status, and more. Quality Profiles and file exclusion settings defined on the server are shared between all connected users. Please find the documentation [here](https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode/)",
"markdownDescription": "Connect SonarQube for VS Code to SonarQube Cloud to apply the same Clean Code standards as your team. Analyze more languages, detect more issues **on the whole project**, receive notifications about the quality gate status, and more. Quality Profiles and file exclusion settings defined on the server are shared between all connected users. Please find the documentation [here](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode/)",
"items": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -353,7 +353,7 @@
"order": 100,
"type": "boolean",
"default": false,
"markdownDescription": "Highlight issues in new code.\n\nFocusing on new code helps you practice [Clean as You Code](https://docs.sonarsource.com/sonarlint/vs-code/clean-as-you-code-in-the-ide/).\n\nIn [Connected Mode](https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode/) you benefit from a more accurate new code definition based on your SonarQube (Server, Cloud) settings.\n\nWithout Connected Mode (in standalone mode), any code added or changed in the **last 30 days** is considered new code.",
"markdownDescription": "Highlight issues in new code.\n\nFocusing on new code helps you practice [Clean as You Code](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/clean-as-you-code-in-the-ide/).\n\nIn [Connected Mode](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode/) you benefit from a more accurate new code definition based on your SonarQube (Server, Cloud) settings.\n\nWithout Connected Mode (in standalone mode), any code added or changed in the **last 30 days** is considered new code.",
"scope": "window"
}
}
Expand Down Expand Up @@ -590,7 +590,7 @@
},
{
"view": "SonarLint.SecurityHotspots",
"contents": "Please ensure a connection to [SonarQube Server](command:SonarLint.HelpAndFeedbackLinkClicked?%22sonarQubeProductPage%22) 9.9+ or [SonarQube Cloud](command:SonarLint.HelpAndFeedbackLinkClicked?%22sonarCloudProductPage%22) is set up. Detected Security Hotspots will be displayed here. [Learn More](https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/security-hotspots).\n Using the In Whole Folder feature may consume excessive resources depending on the size of your project. Please check the [documentation](https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/security-hotspots/#reporting-security-hotspots-in-the-whole-folder) for recommendations to minimize the impact of a full project analysis."
"contents": "Please ensure a connection to [SonarQube Server](command:SonarLint.HelpAndFeedbackLinkClicked?%22sonarQubeProductPage%22) 9.9+ or [SonarQube Cloud](command:SonarLint.HelpAndFeedbackLinkClicked?%22sonarCloudProductPage%22) is set up. Detected Security Hotspots will be displayed here. [Learn More](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/security-hotspots).\n Using the In Whole Folder feature may consume excessive resources depending on the size of your project. Please check the [documentation](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/security-hotspots/#reporting-security-hotspots-in-the-whole-folder) for recommendations to minimize the impact of a full project analysis."
}
],
"walkthroughs": [
Expand All @@ -602,7 +602,7 @@
{
"id": "SonarLint.inAction",
"title": "$(rocket) New to SonarQube for VS Code? See it in action",
"description": "SonarQube for VS Code supports analysis of 15+ languages including JS/TS, Java, Python, CSS/HTML, C, C++, C#, and [more](https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/rules). SonarQube for VS Code detects issues in all files **open** in the editor. For project-level analysis, check out [SonarQube Cloud](command:SonarLint.HelpAndFeedbackLinkClicked?%22sonarCloudProductPage%22).\n\nThe best way to get started is to see it in action!\n[Open Sample File](command:SonarLint.OpenSample)",
"description": "SonarQube for VS Code supports analysis of 15+ languages including JS/TS, Java, Python, CSS/HTML, C, C++, C#, and [more](https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/rules). SonarQube for VS Code detects issues in all files **open** in the editor. For project-level analysis, check out [SonarQube Cloud](command:SonarLint.HelpAndFeedbackLinkClicked?%22sonarCloudProductPage%22).\n\nThe best way to get started is to see it in action!\n[Open Sample File](command:SonarLint.OpenSample)",
"media": {
"markdown": "walkthrough/empty.md"
},
Expand Down
2 changes: 1 addition & 1 deletion src/commons.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
export const DEFAULT_CONNECTION_ID = '<default>';

export namespace SonarLintDocumentation {
export const BASE_DOCS_URL = "https://docs.sonarsource.com/sonarlint/vs-code/";
export const BASE_DOCS_URL = "https://docs.sonarsource.com/sonarqube-for-ide/vs-code/";

export const C_CPP_ANALYSIS = BASE_DOCS_URL + "getting-started/running-an-analysis/#analyze-c-and-cpp-code";
export const CONNECTED_MODE = BASE_DOCS_URL + "team-features/connected-mode/";
Expand Down
2 changes: 1 addition & 1 deletion src/connected/binding.ts
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,7 @@ export class BindingService {
if (selection === SHARE_CONFIGURATION_ACTION) {
this.sharedConnectedModeSettingsService.createSharedConnectedModeSettingsFile(workspaceFolder);
} else if (selection === LEARN_MORE_ACTION) {
VSCode.commands.executeCommand(OPEN_BROWSER, VSCode.Uri.parse('https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode-setup/#reuse-the-binding-configuration'));
VSCode.commands.executeCommand(OPEN_BROWSER, VSCode.Uri.parse('https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode-setup/#reuse-the-binding-configuration'));
}
});
}
Expand Down
6 changes: 3 additions & 3 deletions src/connected/connectionsetup.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ import { escapeHtml, ResourceResolver } from '../util/webview';

let connectionSetupPanel: vscode.WebviewPanel;

const sonarQubeNotificationsDocUrl = 'https://docs.sonarqube.org/latest/user-guide/sonarlint-connected-mode/';
const sonarQubeNotificationsDocUrl = 'https://docs.sonarsource.com/sonarqube-server/latest/user-guide/sonarlint-connected-mode/';
const sonarCloudNotificationsDocUrl =
'https://docs.sonarsource.com/sonarcloud/improving/sonarlint/#smart-notifications';
'https://docs.sonarsource.com/sonarqube-cloud/improving/sonarlint/#smart-notifications';
const TOKEN_RECEIVED_COMMAND = 'tokenReceived';
const OPEN_TOKEN_GENERATION_PAGE_COMMAND = 'openTokenGenerationPage';
const SAVE_CONNECTION_COMMAND = 'saveConnection';
Expand Down Expand Up @@ -243,7 +243,7 @@ function renderConnectionSetupPanel(context: vscode.ExtensionContext, webview: v
<br>
${maybeFolderBindingParagraph}
<br>
<a href='https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode-setup/#connection-setup'>Need help setting up a connection?</a>
<a href='https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode-setup/#connection-setup'>Need help setting up a connection?</a>
<div id="connectionCheck" class="formRowWithStatus">
<vscode-button id="saveConnection" disabled>${saveButtonLabel}</vscode-button>
<span id="connectionProgress" class="hidden">
Expand Down
2 changes: 1 addition & 1 deletion src/help/constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ export const helpAndFeedbackItems: HelpAndFeedbackItem[] = [
{
id: 'connectedModeDocs',
label: 'Connected Mode',
url: 'https://docs.sonarsource.com/sonarlint/vs-code/team-features/connected-mode/',
url: 'https://docs.sonarsource.com/sonarqube-for-ide/vs-code/team-features/connected-mode/',
icon: 'n/a',
viewItem: false
},
Expand Down
2 changes: 1 addition & 1 deletion src/hotspot/hotspots.ts
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Please make sure that the right folder is open and bound to the right project on
if (action === 'Show Documentation') {
vscode.commands.executeCommand(
Commands.OPEN_BROWSER,
vscode.Uri.parse('https://docs.sonarqube.org/latest/user-guide/security-hotspots/')
vscode.Uri.parse('https://docs.sonarsource.com/sonarqube-server/latest/user-guide/security-hotspots/')
);
}
});
Expand Down
2 changes: 1 addition & 1 deletion src/newcode/newCodeDefinitionService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ export class NewCodeDefinitionService {
.update('focusOnNewCode', !this.focusOnNewCode, VSCode.ConfigurationTarget.Global);
}
if (item.label === `Learn how to deliver clean code with Clean as You Code`) {
VSCode.env.openExternal(VSCode.Uri.parse('https://docs.sonarsource.com/sonarlint/vs-code/using-sonarlint/investigating-issues/#focusing-on-new-code'));
VSCode.env.openExternal(VSCode.Uri.parse('https://docs.sonarsource.com/sonarqube-for-ide/vs-code/using-sonarlint/investigating-issues/#focusing-on-new-code'));
}
});
}));
Expand Down
4 changes: 2 additions & 2 deletions src/util/showMessage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export async function tooManyFilesConfirmation(filesCount: number): Promise<Hots
return vscode.window.showWarningMessage(
`There are ${filesCount} files to analyze for hotspots in project.
Analysis may consume too many resources. Do you want to proceed?\n
[Server analysis recommended](https://docs.sonarqube.org/latest/analyzing-source-code/overview/)`,
[Server analysis recommended](https://docs.sonarsource.com/sonarqube-server/latest/analyzing-source-code/overview/)`,
HotspotAnalysisConfirmation.RUN_ANALYSIS, HotspotAnalysisConfirmation.DONT_ANALYZE
);
}
Expand Down Expand Up @@ -100,7 +100,7 @@ and that the file has not been removed or renamed.`,
)
.then(action => {
if (action === 'Show Documentation') {
vscode.commands.executeCommand(Commands.OPEN_BROWSER, vscode.Uri.parse('https://docs.sonarsource.com/sonarlint/vs-code/troubleshooting/#no-matching-issue-found'));
vscode.commands.executeCommand(Commands.OPEN_BROWSER, vscode.Uri.parse('https://docs.sonarsource.com/sonarqube-for-ide/vs-code/troubleshooting/#no-matching-issue-found'));
}
});
}
Loading

0 comments on commit ee2192d

Please sign in to comment.