Просмотр исходного кода

Docs/kevin/doc-21 (#6315)

* Clean as you code link. (d2/2)

* minor text clarification

* minor text removal

* Update server/sonar-docs/src/pages/analysis/pull-request.md

Co-authored-by: Philippe Perrin <philippe.perrin@sonarsource.com>

* fix typo on 1st comment

* fix typo on 1st comment

* fix typo on 1st comment

* fix typo on 1st comment

Co-authored-by: Philippe Perrin <philippe.perrin@sonarsource.com>
tags/9.6.0.59041
kevin.hinz 1 год назад
Родитель
Сommit
dcba4f6bc9

+ 1
- 1
server/sonar-docs/src/pages/analysis/background-tasks.md Просмотреть файл

@@ -26,7 +26,7 @@ Background tasks usually succeed, but sometimes unusual circumstances cause proc
When that happens, the failed status is reflected on the project homepage, but that requires someone to notice it. You can also choose to be notified by email when background tasks fail - either on a project by project basis, or globally on all projects where you have administration rights, in the **Notifications** section of your profile.

## How do I diagnose a failing background task?
For each Analysis Report there is a dropdown menu allowing you to access to the "Scanner Context" showing you the configuration of the Scanner at the moment when the code scan has been run.
For each Analysis Report there is a dropdown menu allowing access to the "Scanner Context," displaying the configuration of the Scanner at the moment when the code scan has been run.

If processing failed for the task, an additional option will be available: "Show Error Details", to get the technical details why the processing of the Background Task failed.


+ 1
- 1
server/sonar-docs/src/pages/analysis/github-integration.md Просмотреть файл

@@ -20,7 +20,7 @@ With this integration, you'll be able to:
Community Edition doesn't support the analysis of multiple branches, so you can only analyze your main branch. With [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), you can analyze multiple branches and pull requests.

## Importing your GitHub repositories to SonarQube
You need to use a GitHub App to connect SonarQube and GitHub so you can import your GitHub repositories into SonarQube. This is also the first step in adding authentication, and, starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), the first step in reporting your analysis and Quality Gate status to your pull requests.
You need to use a GitHub App to connect SonarQube with GitHub and import your GitHub repositories into SonarQube. This is also the first step in adding authentication, and, starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html), the first step in reporting your analysis and Quality Gate status to your pull requests.

If you want to set up authentication without importing your GitHub repositories, see the **Creating a dedicated app for authentication** section below for instructions on setting up authentication.


+ 1
- 1
server/sonar-docs/src/pages/analysis/overview.md Просмотреть файл

@@ -56,5 +56,5 @@ The icon goes away once processing is complete, but if analysis report processin
**Q.** Analysis errors out with `java.lang.OutOfMemoryError: GC overhead limit exceeded`. What do I do?
**A.** This means your project is too large or too intricate for the scanner to analyze with the default memory allocation. To fix this you'll want to allocate a larger heap (using `-Xmx[numeric value here]`) to the process running the analysis. Some CI engines may give you an input to specify the necessary values, for instance if you're using a Maven Build Step in a Jenkins job to run analysis. Otherwise, use Java Options to set a higher value. Note that details of setting Java Options are omitted here because they vary depending on the environment.

**Q.** Analysis errors out with `PKIX path building failed`. What do I do?
**Q.** Analysis errors out with `PKIX path building failed`. What do I do?
**A.** This error tells you that your SonarQube server is configured with HTTPS and a custom SSL certificate. However, the certificate is not correctly configured in the scanner machine’s JVM. This configuration is outside of SonarQube scope. The server certificate is unknown and could not be validated with the provided truststore. You need to add the SonarQube server certificate to the Java truststore. See [Oracle's documentation](https://docs.oracle.com/cd/E19830-01/819-4712/ablqw/index.html) for more information.

+ 3
- 1
server/sonar-docs/src/pages/analysis/pull-request.md Просмотреть файл

@@ -11,6 +11,8 @@ Pull Request analysis shows your Pull Request's Quality Gate and analysis in the

![Pull Request Analysis.](/images/pranalysis.png)

The New Code should be your focus moving forward when using the [Clean as you code](/user-guide/clean-as-you-code/) strategy. More about this can be found in the SonarQube [User Guide Concepts](https://docs.sonarqube.org/latest/user-guide/concepts/) pages.

## Prerequisites

Before analyzing your Pull Requests, make sure that:
@@ -33,7 +35,7 @@ You can also report the pull request analysis and Quality Gate status directly i
## Pull request Quality Gate

A [Quality Gate](/user-guide/quality-gates/) lets you ensure you are meeting your organization's quality policy and that you can merge your pull request. The pull request uses your project Quality Gate as follows:
* **Focuses on new code** – The Pull Request quality gate only uses your project's quality gate conditions that apply to "on New Code" metrics.
* **Focuses on new code** – The Pull Request quality gate only uses your project's quality gate conditions that apply to "on New Code" metrics using the [Clean as you code](/user-guide/clean-as-you-code/) strategy.
* **Assigns a status** – Each Pull Request shows a quality gate status reflecting whether it Passed or Failed.

Pull request analyses on SonarQube are deleted automatically after 30 days with no analysis. This can be updated in **Administration > Configuration > General Settings > Housekeeping > Number of days before purging inactive branches**.

+ 1
- 1
server/sonar-docs/src/pages/branches/branches-faq.md Просмотреть файл

@@ -25,4 +25,4 @@ Yes, an extra node called "branch" is added to the payload.
When the computation of the background task is done for a given branch.

## What is the impact on my LOCs consumption vs my license?
The LOC of your largest branch are counted toward your license limit. All other branches are ignored.
The [LOC](/instance-administration/license-manager/) of your largest branch are counted toward your license limit. All other branches are ignored.

+ 1
- 1
server/sonar-docs/src/pages/branches/overview.md Просмотреть файл

@@ -25,7 +25,7 @@ Branch settings and Quality Profiles are the same as those set for the main bran

### New Code

You can set a New Code definition for each branch. This is especially helpful if you are likely to develop and release multiple versions from the branch. See the [Defining New Code](/project-administration/new-code-period/) documentation for more information.
You can set a New Code definition for each branch. This is especially helpful if you are likely to develop and release multiple versions from the branch. See the [Defining New Code](/project-administration/new-code-period/) documentation for more information, and look at the [Clean as you code](/user-guide/clean-as-you-code/) strategy to learn how to implement this best practice.

### Quality Gate


+ 2
- 2
server/sonar-docs/src/pages/setup/get-started-2-minutes.md Просмотреть файл

@@ -2,7 +2,7 @@
title: Try Out SonarQube
url: /setup/get-started-2-minutes/
---
You've heard about how [SonarQube](https://www.sonarqube.org/) can help you write cleaner and safer code, and now you're ready to try it out for yourself. This guide shows you how to install a local instance of SonarQube and analyze a project. Installing a local instance gets you up and running quickly, so you can experience SonarQube first hand.
You've heard about how [SonarQube](https://www.sonarqube.org/) and the [Clean as you code](/user-guide/clean-as-you-code/) strategy can help you write cleaner and safer code, and now you're ready to try it out for yourself. This guide shows you how to install a local instance of SonarQube and analyze a project. Installing a local instance gets you up and running quickly, so you can experience SonarQube firsthand.

Once you're ready to set up a production instance, take a look at the [Install SonarQube](/setup/install-server/) documentation.

@@ -59,4 +59,4 @@ After successfully analyzing your code, you'll see your first analysis on SonarQ

![successful analysis](/images/successfulproject.png)

Your first analysis is a measure of your current code. As a developer, you focus on maintaining high standards and taking responsibility specifically for the New Code you're working on. Code that has been added or changed from this point should be your focus moving forward. For more information about the [Clean as you code](/user-guide/clean-as-you-code/) strategy, please review the SonarQube [User Guide Concepts](https://docs.sonarqube.org/latest/user-guide/concepts/).

Загрузка…
Отмена
Сохранить