From ae97c2a3e1edf79d152a00ace345417f80c7bd2f Mon Sep 17 00:00:00 2001 From: michaelbirnstiehl Date: Wed, 15 Sep 2021 14:08:39 -0500 Subject: [PATCH] SONAR-15226 Replace ALM with DevOps Platform --- .../pages/analysis/azuredevops-integration.md | 12 ++++++------ .../analysis/bitbucket-cloud-integration.md | 16 ++++++++-------- .../pages/analysis/bitbucket-integration.md | 18 +++++++++--------- .../src/pages/analysis/github-integration.md | 16 ++++++++-------- .../src/pages/analysis/gitlab-integration.md | 14 +++++++------- .../sonar-docs/src/pages/analysis/jenkins.md | 8 ++++---- .../sonar-docs/src/pages/analysis/overview.md | 4 ++-- .../src/pages/analysis/pull-request.md | 6 +++--- .../scan/sonarscanner-for-azure-devops.md | 2 +- .../architecture/architecture-integration.md | 2 +- .../sonar-docs/src/pages/branches/overview.md | 4 ++-- server/sonar-docs/src/pages/index.md | 4 ++-- .../instance-administration/delegated-auth.md | 2 +- .../src/pages/user-guide/clean-as-you-code.md | 2 +- .../static/SonarQubeNavigationTree.json | 2 +- .../static/StaticNavigationTree.json | 2 +- 16 files changed, 57 insertions(+), 57 deletions(-) diff --git a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md index 62b1528d00c..fbd87d0dccf 100644 --- a/server/sonar-docs/src/pages/analysis/azuredevops-integration.md +++ b/server/sonar-docs/src/pages/analysis/azuredevops-integration.md @@ -21,11 +21,11 @@ Setting up the import of Azure DevOps repositories into SonarQube allows you to To set up the import of Azure DevOps repositories: -1. Set your global settings +1. Set your global DevOps Platform settings 2. Add a personal access token for importing repositories ### Setting your global settings -To import your Azure DevOps repositories into SonarQube, you need to first set your global SonarQube settings. Navigate to **Administration > Configuration > General Settings > ALM Integrations**, select the **Azure DevOps** tab, and click the **Create configuration** button. Specify the following settings: +To import your Azure DevOps repositories into SonarQube, you need to first set your global SonarQube settings. Navigate to **Administration > Configuration > General Settings > DevOps Platform Integrations**, select the **Azure DevOps** tab, and click the **Create configuration** button. Specify the following settings: - **Configuration Name** (Enterprise and Data Center Edition only) – The name used to identify your Azure DevOps configuration at the project level. Use something succinct and easily recognizable. - **Azure DevOps collection/organization URL** – If you are using Azure DevOps Server, provide your full Azure DevOps collection URL. For example, `https://ado.your-company.com/DefaultCollection`. If you are using Azure DevOps Services, provide your full Azure DevOps organization URL. For example, `https://dev.azure.com/your_organization`. @@ -329,12 +329,12 @@ SonarQube can also report your Quality Gate status to Azure DevOps pull requests | Because of the nature of a mono repository, SonarQube scanners might read all project names of your mono repository as identical. To avoid having multiple projects with the same name, you need to pass the `sonar.projectName` parameter to the scanner. For example, if you're using the Maven scanner, you would pass `mvn sonar:sonar -Dsonar.projectName=YourProjectName`. [[collapse]] -| ## Configuring multiple ALM instances -| SonarQube can report your Quality Gate status to multiple ALM instances. To do this, you need to create a configuration for each ALM instance and assign that configuration to the appropriate projects. +| ## Configuring multiple DevOps Platform instances +| SonarQube can report your Quality Gate status to multiple DevOps Platform instances. To do this, you need to create a configuration for each DevOps Platform instance and assign that configuration to the appropriate projects. | -| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each ALM. +| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each DevOps Platform. | -| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each ALM. If you have multiple configurations of the same ALM connected to SonarQube, you have to create projects manually. +| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each DevOps Platform. If you have multiple configurations of the same DevOps Platform connected to SonarQube, you have to create projects manually. [[collapse]] | ## Linking issues diff --git a/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md b/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md index 0225cd1e0c0..f0d2789f408 100644 --- a/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md +++ b/server/sonar-docs/src/pages/analysis/bitbucket-cloud-integration.md @@ -16,12 +16,12 @@ With this integration, you'll be able to: Setting up the import of BitBucket Cloud repositories into SonarQube allows you to easily create SonarQube projects from your Bitbucket Cloud repositories. If you're using Developer Edition or above, this is also the first step in adding pull request decoration. [[info]] -| To import your Bitbucket repositories into SonarQube, you can only have one global configuration of Bitbucket, including Bitbucket Server and Bitbucket Cloud. See the **Configuring multiple ALM instances** section below for more information. +| To import your Bitbucket repositories into SonarQube, you can only have one global configuration of Bitbucket, including Bitbucket Server and Bitbucket Cloud. See the **Configuring multiple DevOps Platform instances** section below for more information. To set up the import of BitBucket Cloud repositories: 1. Create an OAuth consumer. -1. Set your global ALM integration settings. +1. Set your global DevOps Platform integration settings. 1. Add your Bitbucket username and an app password. ### Creating your OAuth consumer @@ -32,8 +32,8 @@ SonarQube uses a dedicated [OAuth consumer](https://support.atlassian.com/bitbuc - **This is a private consumer** – Your OAuth consumer needs to be private. Make sure this check box is selected. - **Permissions** – Grant **Read** access for the **Pull requests** permission. -### Setting your global ALM Integration settings -To set your global ALM Integration settings, navigate to **Administration > ALM Integrations**, select the **Bitbucket** tab, and select **Bitbucket Cloud** as the variant you want to configure. From here, specify the following settings: +### Setting your global DevOps Platform Integration settings +To set your global DevOps Platform Integration settings, navigate to **Administration > DevOps Platform Integrations**, select the **Bitbucket** tab, and select **Bitbucket Cloud** as the variant you want to configure. From here, specify the following settings: - **Configuration Name** (Enterprise and Data Center Edition only) – The name used to identify your Bitbucket Cloud configuration at the project level. Use something succinct and easily recognizable. - **Workspace ID** – The workspace ID is part of your bitbucket cloud URL `https://bitbucket.org/{WORKSPACE-ID}/{repository-slug}` @@ -302,12 +302,12 @@ SonarQube can also report your Quality Gate status to Bitbucket Cloud pull reque | Because of the nature of a mono repository, SonarQube scanners might read all project names of your mono repository as identical. To avoid having multiple projects with the same name, you need to pass the `sonar.projectName` parameter to the scanner. For example, if you're using the Maven scanner, you would pass `mvn sonar:sonar -Dsonar.projectName=YourProjectName`. [[collapse]] -| ## Configuring multiple ALM instances -| SonarQube can report your Quality Gate status to multiple ALM instances. To do this, you need to create a configuration for each ALM instance and assign that configuration to the appropriate projects. +| ## Configuring multiple DevOps Platform instances +| SonarQube can report your Quality Gate status to multiple DevOps Platform instances. To do this, you need to create a configuration for each DevOps Platform instance and assign that configuration to the appropriate projects. | -| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each ALM. +| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each DevOps Platform. | -| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each ALM. If you have multiple configurations of the same ALM connected to SonarQube, you have to create projects manually. +| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each DevOps Platform. If you have multiple configurations of the same DevOps Platform connected to SonarQube, you have to create projects manually. [[collapse]] | ## Linking issues diff --git a/server/sonar-docs/src/pages/analysis/bitbucket-integration.md b/server/sonar-docs/src/pages/analysis/bitbucket-integration.md index 23d8ae9c45d..d157503fc2a 100644 --- a/server/sonar-docs/src/pages/analysis/bitbucket-integration.md +++ b/server/sonar-docs/src/pages/analysis/bitbucket-integration.md @@ -19,15 +19,15 @@ Community Edition doesn't support the analysis of multiple branches, so you can Setting up the import of BitBucket Server repositories into SonarQube allows you to easily create SonarQube projects from your Bitbucket Server repositories. If you're using [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) or above, this is also the first step in adding pull request decoration. [[info]] -| To import your Bitbucket repositories into SonarQube, you can only have one global configuration of Bitbucket, including Bitbucket Server and Bitbucket Cloud. See the **Configuring multiple ALM instances** section below for more information. +| To import your Bitbucket repositories into SonarQube, you can only have one global configuration of Bitbucket, including Bitbucket Server and Bitbucket Cloud. See the **Configuring multiple DevOps Platform instances** section below for more information. To set up the import of BitBucket Server repositories: -1. Set your global ALM integration settings +1. Set your global DevOps Platform integration settings 1. Add a personal access token for importing repositories -### Setting your global ALM Integration settings -To set your global ALM Integration settings, navigate to **Administration > ALM Integrations**, select the **Bitbucket** tab, and select **Bitbucket Server** as the variant you want to configure. From here, specify the following settings: +### Setting your global DevOps Platform Integration settings +To set your global DevOps Platform Integration settings, navigate to **Administration > DevOps Platform Integrations**, select the **Bitbucket** tab, and select **Bitbucket Server** as the variant you want to configure. From here, specify the following settings: - **Configuration Name** (Enterprise and Data Center Edition only) – The name used to identify your Bitbucket Server configuration at the project level. Use something succinct and easily recognizable. - **Bitbucket Server URL** – your instances URL. For example, `https://bitbucket-server.your-company.com`. @@ -57,7 +57,7 @@ If you're creating your projects manually or adding Quality Gate reporting to an ### Reporting your Quality Gate status in manually created or existing projects SonarQube can also report your Quality Gate status to Bitbucket Server for existing projects and manually-created projects. After you've updated your global settings as shown in the **Importing your Bitbucket Server repositories into SonarQube** section above, set the following project settings at **Project Settings > General Settings > DevOps Platform Integration**: -- **Configuration name** – The configuration name that corresponds to your ALM instance. +- **Configuration name** – The configuration name that corresponds to your DevOps Platform instance. - **Project Key** – the project key is part of your BitBucket Server repository URL (.../projects/**{KEY}**/repos/{SLUG}/browse). - **Repository SLUG** – The repository slug is part of your BitBucket Server repository URL (.../projects/{KEY}/repos/**{SLUG}**/browse). @@ -81,12 +81,12 @@ SonarQube can also report your Quality Gate status to Bitbucket Server for exist | Because of the nature of a mono repository, SonarQube scanners might read all project names of your mono repository as identical. To avoid having multiple projects with the same name, you need to pass the `sonar.projectName` parameter to the scanner. For example, if you're using the Maven scanner, you would pass `mvn sonar:sonar -Dsonar.projectName=YourProjectName`. [[collapse]] -| ## Configuring multiple ALM instances -| SonarQube can report your Quality Gate status to multiple ALM instances. To do this, you need to create a configuration for each ALM instance and assign that configuration to the appropriate projects. +| ## Configuring multiple DevOps Platform instances +| SonarQube can report your Quality Gate status to multiple DevOps Platform instances. To do this, you need to create a configuration for each DevOps Platform instance and assign that configuration to the appropriate projects. | -| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each ALM. +| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each DevOps Platform. | -| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each ALM. If you have multiple configurations of the same ALM connected to SonarQube, you have to create projects manually. +| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each DevOps Platform. If you have multiple configurations of the same DevOps Platform connected to SonarQube, you have to create projects manually. [[collapse]] | ## Linking issues diff --git a/server/sonar-docs/src/pages/analysis/github-integration.md b/server/sonar-docs/src/pages/analysis/github-integration.md index b8ce1afc5ab..290228801db 100644 --- a/server/sonar-docs/src/pages/analysis/github-integration.md +++ b/server/sonar-docs/src/pages/analysis/github-integration.md @@ -79,7 +79,7 @@ Next, you need to install your GitHub App in your organizations. See GitHub's do ### Step 3: Updating your SonarQube global settings with your GitHub App information After you've created and installed your GitHub App, update your global SonarQube settings to finish integration and allow for the import of GitHub projects. -Navigate to **Administration > Configuration > General Settings > ALM Integrations > GitHub** and specify the following settings: +Navigate to **Administration > Configuration > General Settings > DevOps Platform Integrations > GitHub** and specify the following settings: - **Configuration Name** (Enterprise and Data Center Edition only) – The name used to identify your GitHub configuration at the project level. Use something succinct and easily recognizable. - **GitHub URL** – For example, `https://github.company.com/api/v3` for GitHub Enterprise or `https://api.github.com/` for GitHub.com. @@ -303,7 +303,7 @@ Then, follow the steps in SonarQube to analyze your project. SonarQube automatic If you're creating your projects manually or adding Quality Gate reporting to an existing project, see the following section. ### Reporting your Quality Gate status in manually created or existing projects -SonarQube can also report your Quality Gate status to GitHub pull requests and branches for existing and manually-created projects. After you've created and installed your GitHub App and updated your global ALM Integration settings as shown in the **Importing your GitHub repositories into SonarQube** section above, set the following project settings at **Project Settings > General Settings > DevOps Platform Integration**: +SonarQube can also report your Quality Gate status to GitHub pull requests and branches for existing and manually-created projects. After you've created and installed your GitHub App and updated your global DevOps Platform Integration settings as shown in the **Importing your GitHub repositories into SonarQube** section above, set the following project settings at **Project Settings > General Settings > DevOps Platform Integration**: - **Configuration name** – The configuration name that corresponds to your GitHub instance. - **Repository identifier** – The path of your repository URL. @@ -332,12 +332,12 @@ SonarQube can also report your Quality Gate status to GitHub pull requests and b | By default, **Enable analysis summary under the GitHub Conversation tab** is on and your pull request analysis will be shown under both the **Conversation** and **Checks** tabs in GitHub. When off, your pull request analysis summary is only shown under the **Checks** tab. [[collapse]] -| ## Configuring multiple ALM instances -| SonarQube can report your Quality Gate status to multiple ALM instances. To do this, you need to create a configuration for each ALM instance and assign that configuration to the appropriate projects. +| ## Configuring multiple DevOps Platform instances +| SonarQube can report your Quality Gate status to multiple DevOps Platform instances. To do this, you need to create a configuration for each DevOps Platform instance and assign that configuration to the appropriate projects. | -| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each ALM. +| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each DevOps Platform. | -| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each ALM. If you have multiple configurations of the same ALM connected to SonarQube, you have to create projects manually. +| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each DevOps Platform. If you have multiple configurations of the same DevOps Platform connected to SonarQube, you have to create projects manually. [[collapse]] | ## Linking issues @@ -351,7 +351,7 @@ To allow users to log in with GitHub credentials, use the GitHub App that you cr To update your global SonarQube settings: -Navigate to **Administration > Configuration > General Settings > ALM Integrations > GitHub > GitHub Authentication** and update the following: +Navigate to **Administration > Configuration > General Settings > DevOps Platform Integrations > GitHub > GitHub Authentication** and update the following: 1. **Enabled** – set the switch to `true`. 1. **Client ID** – the Client ID is found below the GitHub App ID on your GitHub App's page. @@ -367,7 +367,7 @@ If you want to use a dedicated app for GitHub authentication, you can create a G After creating your app, update your global SonarQube settings: -Navigate to **Administration > Configuration > General Settings > ALM Integrations > GitHub > GitHub Authentication** and update the following: +Navigate to **Administration > Configuration > General Settings > DevOps Platform Integrations > GitHub > GitHub Authentication** and update the following: 1. **Enabled** – set the switch to `true`. 1. **Client ID** – the Client ID is found below the GitHub App ID on your GitHub App's page. diff --git a/server/sonar-docs/src/pages/analysis/gitlab-integration.md b/server/sonar-docs/src/pages/analysis/gitlab-integration.md index a318bf1ad6f..032cd5102c0 100644 --- a/server/sonar-docs/src/pages/analysis/gitlab-integration.md +++ b/server/sonar-docs/src/pages/analysis/gitlab-integration.md @@ -30,7 +30,7 @@ Specify the following settings in your OAuth app: - **Redirect URI** – enter your SonarQube URL with the path `/oauth2/callback/gitlab`. For example, `https://sonarqube.mycompany.com/oauth2/callback/gitlab`. - **Scopes** – select **api** if you plan to enable group synchronization. Select **read_user** if you only plan to delegate authentication. -After saving your application, GitLab takes you to the app's page. Here you find your **Application ID** and **Secret**. Keep these handy, open your SonarQube instance, and navigate to **Administration > Configuration > General Settings > ALM Integrations > GitLab > Authentication**. Set the following settings to finish setting up GitLab authentication: +After saving your application, GitLab takes you to the app's page. Here you find your **Application ID** and **Secret**. Keep these handy, open your SonarQube instance, and navigate to **Administration > Configuration > General Settings > DevOps Platform Integrations > GitLab > Authentication**. Set the following settings to finish setting up GitLab authentication: - **Enabled** – set to `true`. - **Application ID** – the Application ID is found on your GitLab app's page. @@ -39,7 +39,7 @@ After saving your application, GitLab takes you to the app's page. Here you find On the login form, the new "Log in with GitLab" button allows users to connect with their GitLab accounts. ### GitLab group synchronization -Enable **Synchronize user groups** at **Administration > Configuration > General Settings > ALM Integrations > GitLab** to associate GitLab groups with existing SonarQube groups of the same name. GitLab users inherit membership to subgroups from parent groups. +Enable **Synchronize user groups** at **Administration > Configuration > General Settings > DevOps Platform Integrations > GitLab** to associate GitLab groups with existing SonarQube groups of the same name. GitLab users inherit membership to subgroups from parent groups. To synchronize a GitLab group or subgroup with a SonarQube group, name the SonarQube group with the full path of the GitLab group or subgroup URL. @@ -60,7 +60,7 @@ To set up the import of GitLab projects: 1. Add a personal access token for importing repositories ### Setting your global settings -To import your GitLab projects into SonarQube, you need to first set your global SonarQube settings. Navigate to **Administration > Configuration > General Settings > ALM Integrations**, select the **GitLab** tab, and specify the following settings: +To import your GitLab projects into SonarQube, you need to first set your global SonarQube settings. Navigate to **Administration > Configuration > General Settings > DevOps Platform Integrations**, select the **GitLab** tab, and specify the following settings: - **Configuration Name** (Enterprise and Data Center Edition only) – The name used to identify your GitLab configuration at the project level. Use something succinct and easily recognizable. - **GitLab URL** – The GitLab API URL. @@ -231,12 +231,12 @@ SonarQube can also report your Quality Gate status to GitLab merge requests for | Because of the nature of a mono repository, SonarQube scanners might read all project names of your mono repository as identical. To avoid having multiple projects with the same name, you need to pass the `sonar.projectName` parameter to the scanner. For example, if you're using the Maven scanner, you would pass `mvn sonar:sonar -Dsonar.projectName=YourProjectName`. [[collapse]] -| ## Configuring multiple ALM instances -| SonarQube can report your Quality Gate status to multiple ALM instances. To do this, you need to create a configuration for each ALM instance and assign that configuration to the appropriate projects. +| ## Configuring multiple DevOps Platform instances +| SonarQube can report your Quality Gate status to multiple DevOps Platform instances. To do this, you need to create a configuration for each DevOps Platform instance and assign that configuration to the appropriate projects. | -| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each ALM. +| - As part of [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can create one configuration for each DevOps Platform. | -| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each ALM. If you have multiple configurations of the same ALM connected to SonarQube, you have to create projects manually. +| - Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can create multiple configurations for each DevOps Platform. If you have multiple configurations of the same DevOps Platform connected to SonarQube, you have to create projects manually. [[collapse]] | ## Linking issues diff --git a/server/sonar-docs/src/pages/analysis/jenkins.md b/server/sonar-docs/src/pages/analysis/jenkins.md index 630f148e6ad..7e754f3a0dc 100644 --- a/server/sonar-docs/src/pages/analysis/jenkins.md +++ b/server/sonar-docs/src/pages/analysis/jenkins.md @@ -10,7 +10,7 @@ SonarScanners running in Jenkins can automatically detect branches and Merge or To run project analysis with Jenkins, you need to install and configure the following Jenkins plugins _in Jenkins_: - The SonarQube Scanner plugin. -- The Branch Source plugin that corresponds to your ALM (Bitbucket Server, GitHub, or GitLab) if you're analyzing multibranch pipeline jobs in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) or above. +- The Branch Source plugin that corresponds to your DevOps Platform (Bitbucket Server, GitHub, or GitLab) if you're analyzing multibranch pipeline jobs in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) or above. See the **Installing and Configuring your Jenkins plugins** section below for more information. @@ -43,7 +43,7 @@ Click SonarQube Scanner below to expand instructions on installing and configuri ### Branch Source plugin _Required to analyze multibranch pipeline jobs in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) or above_ -Click your ALM below to expand the instructions on installing and configuring the Branch Source plugin. +Click your DevOps Platform below to expand the instructions on installing and configuring the Branch Source plugin. [[collapse]] | ## BitBucket Server @@ -90,9 +90,9 @@ Click your ALM below to expand the instructions on installing and configuring th You can easily configure and analyze your projects with Jenkins through the tutorial in SonarQube. [[info]] -| You need to set up SonarQube to import your repositories before accessing the tutorial. See the **ALM Integrations** in the left-side navigation of this documentation for more information. +| You need to set up SonarQube to import your repositories before accessing the tutorial. See the **DevOps Platform Integrations** in the left-side navigation of this documentation for more information. | -| A tutorial is currently available for all supported ALMs except Azure DevOps. +| A tutorial is currently available for all supported DevOps Platforms except Azure DevOps. To access the tutorial: diff --git a/server/sonar-docs/src/pages/analysis/overview.md b/server/sonar-docs/src/pages/analysis/overview.md index 39b514df2a0..3d0307125d7 100644 --- a/server/sonar-docs/src/pages/analysis/overview.md +++ b/server/sonar-docs/src/pages/analysis/overview.md @@ -14,7 +14,7 @@ Once the SonarQube platform has been installed, you're ready to install a scanne * anything else (CLI) - [SonarScanner](/analysis/scan/sonarscanner/) [[info]] -| SonarQube integrations are supported for popular ALMs: GitHub Enterprise and GitHub.com, BitBucket Server, Azure Devops Server and Azure DevOps Services. +| SonarQube integrations are supported for popular DevOps Platforms: GitHub Enterprise and GitHub.com, BitBucket Server, Azure Devops Server and Azure DevOps Services. [[warning]] | We do not recommend running an antivirus scanner on the machine where a SonarQube analysis runs, it could result in unpredictable behavior. @@ -36,7 +36,7 @@ By default, only files that are recognized by your edition of SonarQube are load For example if you're using SonarQube Community Edition, which includes analysis of Java and JavaScript, but not C++, all `.java` and `.js` files would be loaded, but `.cpp` files would be ignored. ## What about branches and pull requests? -_Developer Edition_ adds the ability to analyze your project's [branches](/branches/overview/) and [pull requests](/analysis/pull-request/) as well as the ability to automatically decorate pull requests in some ALM interfaces. +_Developer Edition_ adds the ability to analyze your project's [branches](/branches/overview/) and [pull requests](/analysis/pull-request/) as well as the ability to automatically report your pull request analysis to your DevOps Platform interface. ## What happens during analysis? During analysis, data is requested from the server, the files provided to the analysis are analyzed, and the resulting data is sent back to the server at the end in the form of a report, which is then analyzed asynchronously server-side. diff --git a/server/sonar-docs/src/pages/analysis/pull-request.md b/server/sonar-docs/src/pages/analysis/pull-request.md index 57c0161ffd8..1df3a875731 100644 --- a/server/sonar-docs/src/pages/analysis/pull-request.md +++ b/server/sonar-docs/src/pages/analysis/pull-request.md @@ -15,8 +15,8 @@ Pull Request analysis shows your Pull Request's Quality Gate and analysis in the Before analyzing your Pull Requests, make sure the Pull Request branch is checked out. Avoid any attempt at previewing the merge or actions involving your main branch. -## Pull request decoration -You can also add pull request decoration that shows the Pull Request analysis and Quality Gate directly in your ALM's interface. To set up pull request decoration, see the ALM integration page that corresponds with your ALM: +## Report pull request status to your DevOps Platform +You can also report the pull request analysis and Quality Gate status directly in your DevOps Platform's interface. To set up pull request decoration, see the DevOps Platform integration page that corresponds with your DevOps Platform: - [GitHub Enterprise and GitHub.com](/analysis/github-integration/) - [GitLab Self-Managed and GitLab.com](/analysis/gitlab-integration/) - [Bitbucket Server](/analysis/bitbucket-integration/) @@ -43,6 +43,6 @@ The following parameters enable PR analysis. | Parameter Name | Description | | --------------------- | ---------------------------------- | -| `sonar.pullrequest.key` | Unique identifier of your Pull Request. Must correspond to the key of the Pull Request in your ALM.
e.g.: `sonar.pullrequest.key=5` | +| `sonar.pullrequest.key` | Unique identifier of your Pull Request. Must correspond to the key of the Pull Request in your DevOps Platform.
e.g.: `sonar.pullrequest.key=5` | | `sonar.pullrequest.branch` | The name of the branch that contains the changes to be merged.
e.g.: `sonar.pullrequest.branch=feature/my-new-feature` | | `sonar.pullrequest.base` | The branch into which the Pull Request will be merged.
Default: master
e.g.: `sonar.pullrequest.base=master` | \ No newline at end of file diff --git a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md index d95a6fb25b2..ee886c24148 100644 --- a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-azure-devops.md @@ -22,4 +22,4 @@ The SonarScanner for Azure DevOps is compatible with: * Azure DevOps Services ## Analysis -For information on setting up analysis with the SonarScanner for Azure DevOps, see the [Azure DevOps ALM integration](/analysis/azuredevops-integration/) page. +For information on setting up analysis with the SonarScanner for Azure DevOps, see the [Azure DevOps DevOps Platform integration](/analysis/azuredevops-integration/) page. diff --git a/server/sonar-docs/src/pages/architecture/architecture-integration.md b/server/sonar-docs/src/pages/architecture/architecture-integration.md index 1527174ee1f..5dac3b80a58 100644 --- a/server/sonar-docs/src/pages/architecture/architecture-integration.md +++ b/server/sonar-docs/src/pages/architecture/architecture-integration.md @@ -17,7 +17,7 @@ The SonarQube Platform is made of 4 components: 4. One or more SonarScanners running on your Build / Continuous Integration Servers to analyze projects ## Integration -The following schema shows how SonarQube integrates with other ALM tools and where the various components of SonarQube are used. +The following schema shows how SonarQube integrates with other DevOps Platform tools and where the various components of SonarQube are used. ![SonarQube Integration.](/images/architecture-integrate.png) 1. Developers code in their IDEs and use [SonarLint](https://sonarlint.org) to run local analysis. diff --git a/server/sonar-docs/src/pages/branches/overview.md b/server/sonar-docs/src/pages/branches/overview.md index e0821123b1e..a68e7f14354 100644 --- a/server/sonar-docs/src/pages/branches/overview.md +++ b/server/sonar-docs/src/pages/branches/overview.md @@ -13,7 +13,7 @@ With Branch Analysis, you can ensure that you're maintaining consistent code qua This is the default branch and typically corresponds to what's being developed for your next release. This branch is usually known within a development team as "master" or "head" and is analyzed when no specific branch parameters are provided. SonarQube labels this branch as **Main Branch**, and, with Community Edition, this is the only branch you can analyze. -Adding projects by ALM copies the main branch name in SonarQube from the main branch name in your repository. See **ALM Integrations** in the documentation navigation for more information on adding your project from an ALM. +Adding projects by DevOps Platform copies the main branch name in SonarQube from the main branch name in your repository. See **DevOps Platform Integrations** in the documentation navigation for more information on adding your project from an DevOps Platform. If you add your project manually, your main branch defaults to the name "master". @@ -89,7 +89,7 @@ You can set a branch to **Keep when inactive** at the project level from from th ## Keeping your "master" branch history when upgrading from Community Edition to a commercial edition [[info]] -| If you added a SonarQube project from an ALM instead of manually, the name of the main branch in SonarQube is copied from the name of the main branch in your repository, and you shouldn't have any branch history issues when upgrading to a commercial edition. +| If you added a SonarQube project from an DevOps Platform instead of manually, the name of the main branch in SonarQube is copied from the name of the main branch in your repository, and you shouldn't have any branch history issues when upgrading to a commercial edition. In Community Edition, if you create a project manually, your analyzed branch is named "master" by default. diff --git a/server/sonar-docs/src/pages/index.md b/server/sonar-docs/src/pages/index.md index 306614ea9ba..4659ee73bf8 100644 --- a/server/sonar-docs/src/pages/index.md +++ b/server/sonar-docs/src/pages/index.md @@ -19,7 +19,7 @@ Otherwise, you can also find an overview and common scenarios below or navigate In a typical development process: -1. Developers develop and merge code in an IDE (preferably using [SonarLint](https://www.sonarlint.org/) to receive immediate feedback in the editor) and check-in their code to their ALM. +1. Developers develop and merge code in an IDE (preferably using [SonarLint](https://www.sonarlint.org/) to receive immediate feedback in the editor) and check-in their code to their DevOps Platform. 1. An organization’s continuous integration (CI) tool checks out, builds, and runs unit tests, and an integrated SonarQube scanner analyzes the results. 1. The scanner posts the results to the SonarQube server which provides feedback to developers through the SonarQube interface, email, in-IDE notifications (through SonarLint), and decoration on pull or merge requests (when using [Developer Edition](https://redirect.sonarsource.com/editions/developer.html) and above). @@ -41,7 +41,7 @@ Starting in [Developer Edition](https://redirect.sonarsource.com/editions/develo ### Analyzing pull requests -Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can integrate SonarQube to be part of your pull or merge request process. Issuing a pull request can trigger a branch analysis and add pull request decoration to see your branch analysis directly in your ALM's interface in addition to the SonarQube interface. For more information, see the [Pull Request Analysis Overview](/analysis/pull-request/). +Starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can integrate SonarQube to be part of your pull or merge request process. Issuing a pull request can trigger a branch analysis and add pull request decoration to see your branch analysis directly in your DevOps Platforms's interface in addition to the SonarQube interface. For more information, see the [Pull Request Analysis Overview](/analysis/pull-request/). ## Writing Clean and Safe Code diff --git a/server/sonar-docs/src/pages/instance-administration/delegated-auth.md b/server/sonar-docs/src/pages/instance-administration/delegated-auth.md index c259d6bc4df..6d005b1dab5 100644 --- a/server/sonar-docs/src/pages/instance-administration/delegated-auth.md +++ b/server/sonar-docs/src/pages/instance-administration/delegated-auth.md @@ -32,7 +32,7 @@ All the parameters required to activate and configure this feature are available Using Http header authentication is an easy way integrate your SonarQube deployment with an in-house SSO implementation. ## GitHub and GitLab Authentication -You can delegate authentication to GitHub Enterprise and GitHub.com or GitLab Self-Managed and GitLab.com. See the corresponding ALM integration page for more information: +You can delegate authentication to GitHub Enterprise and GitHub.com or GitLab Self-Managed and GitLab.com. See the corresponding DevOps Platform integration page for more information: - [GitHub Enterprise and GitHub.com](/analysis/github-integration/) - [GitLab Self-Managed and GitLab.com](/analysis/gitlab-integration/) diff --git a/server/sonar-docs/src/pages/user-guide/clean-as-you-code.md b/server/sonar-docs/src/pages/user-guide/clean-as-you-code.md index f5060e7bd8e..a0009cde0e1 100644 --- a/server/sonar-docs/src/pages/user-guide/clean-as-you-code.md +++ b/server/sonar-docs/src/pages/user-guide/clean-as-you-code.md @@ -32,6 +32,6 @@ For more information on Quality Gates and making sure your Quality Gate is enfor ## Pull Request Analysis -You can use Pull Request analysis and decoration to make sure your code is meeting your standards before you merge. Pull Request analysis lets you see your Pull Request's Quality Gate in the SonarQube UI. You can then decorate your Pull Requests with SonarQube issues directly in your ALM's interface. +You can use Pull Request analysis and decoration to make sure your code is meeting your standards before you merge. Pull Request analysis lets you see your Pull Request's Quality Gate in the SonarQube UI. You can then decorate your Pull Requests with SonarQube issues directly in your DevOps Platform's interface. For more information on setting up Pull Request analysis and decoration, see the [Pull Request](/analysis/pull-request/) documentation. diff --git a/server/sonar-docs/static/SonarQubeNavigationTree.json b/server/sonar-docs/static/SonarQubeNavigationTree.json index 3a916a7ce4c..35d565e1f21 100644 --- a/server/sonar-docs/static/SonarQubeNavigationTree.json +++ b/server/sonar-docs/static/SonarQubeNavigationTree.json @@ -84,7 +84,7 @@ ] }, { - "title": "ALM Integration", + "title": "DevOps Platform Integration", "children": [ "/analysis/github-integration/", "/analysis/gitlab-integration/", diff --git a/server/sonar-docs/static/StaticNavigationTree.json b/server/sonar-docs/static/StaticNavigationTree.json index 9cdc8b2c630..48dcddee689 100644 --- a/server/sonar-docs/static/StaticNavigationTree.json +++ b/server/sonar-docs/static/StaticNavigationTree.json @@ -118,7 +118,7 @@ ] }, { - "title": "ALM Integration", + "title": "DevOps Platform Integration", "children": [ "/analysis/github-integration/", "/analysis/gitlab-integration/", -- 2.39.5