Merge branch 'docs/codequality' into 'master'

Rename code climate to code quality

Closes #6183

See merge request gitlab-org/gitlab-ee!6437

doc/README.md

@@ -148,7 +148,7 @@ scales to run your tests faster.
 - [Review Apps](ci/review_apps/index.md): Preview changes to your app right from a merge request.
 - [Pipeline Graphs](ci/pipelines.md#pipeline-graphs)
 - [Multi-project pipelines](ci/multi_project_pipelines.md) **[PREMIUM]**
-- [Code Quality reports](user/project/merge_requests/code_quality_diff.md) **[STARTER]**
+- [Code Quality reports](user/project/merge_requests/code_quality.md) **[STARTER]**
 - [Static Application Security Testing (SAST) reports](user/project/merge_requests/sast.md) **[ULTIMATE]**
 - [Dynamic Application Security Testing (DAST)](user/project/merge_requests/dast.md) **[ULTIMATE]**
 - [Dependency Scanning reports](user/project/merge_requests/dependency_scanning.md) **[ULTIMATE]**

doc/ci/examples/README.md

@@ -43,9 +43,9 @@ There's also a collection of repositories with [example projects](https://gitlab
 - [Using `dpl` as deployment tool](deployment/README.md)
 - [The `.gitlab-ci.yml` file for GitLab itself](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/.gitlab-ci.yml)
 
-## Code quality analysis
+## Code Quality analysis **[STARTER]**
 
-[Analyze code quality with the Code Climate CLI](code_climate.md).
+[Analyze your project's Code Quality](code_quality.md).
 
 ## Dependencies license management **[ULTIMATE]**
 

doc/ci/examples/code_climate.md

-# Analyze project code quality with Code Climate CLI
+---
+redirect_from: 'https://docs.gitlab.com/ee/ci/examples/code_climate.html'
+redirect_to: code_quality.md
+---
 
-This example shows how to run [Code Climate CLI][cli] on your code by using
-GitLab CI and Docker.
-
-First, you need GitLab Runner with [docker-in-docker executor][dind].
-
-Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `code_quality`:
-
-```yaml
-code_quality:
-  image: docker:stable
-  variables:
-    DOCKER_DRIVER: overlay2
-  allow_failure: true
-  services:
-    - docker:stable-dind
-  script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
-    - docker run
-        --env SOURCE_CODE="$PWD"
-        --volume "$PWD":/code
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [gl-code-quality-report.json]
-```
-
-The above example will create a `code_quality` job in your CI/CD pipeline which
-will scan your source code for code quality issues. The report will be saved
-as an artifact that you can later download and analyze.
-
-TIP: **Tip:**
-Starting with [GitLab Starter][ee] 9.3, this information will
-be automatically extracted and shown right in the merge request widget. To do
-so, the CI/CD job must be named `code_quality` and the artifact path must be
-`gl-code-quality-report.json`.
-[Learn more on code quality diffs in merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html).
-
-CAUTION: **Caution:**
-Code Quality was previously using `codeclimate` and `codequality` for job name and
-`codeclimate.json` for the artifact name. While these old names
-are still maintained they have been deprecated with GitLab 11.0 and may be removed
-in next major release, GitLab 12.0. You are advised to update your current `.gitlab-ci.yml`
-configuration to reflect that change.
-
-[cli]: https://github.com/codeclimate/codeclimate
-[dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor
-[ee]: https://about.gitlab.com/pricing/
+This document was moved to [another location](code_quality.md).

doc/ci/examples/code_quality.md

+# Analyze your project's Code Quality
+
+This example shows how to run Code Quality on your code by using GitLab CI/CD
+and Docker.
+
+First, you need GitLab Runner with [docker-in-docker executor][dind].
+
+Once you set up the Runner, add a new job to `.gitlab-ci.yml`, called `code_quality`:
+
+```yaml
+code_quality:
+  image: docker:stable
+  variables:
+    DOCKER_DRIVER: overlay2
+  allow_failure: true
+  services:
+    - docker:stable-dind
+  script:
+    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - docker run
+        --env SOURCE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
+  artifacts:
+    paths: [gl-code-quality-report.json]
+```
+
+The above example will create a `code_quality` job in your CI/CD pipeline which
+will scan your source code for code quality issues. The report will be saved
+as an artifact that you can later download and analyze.
+
+TIP: **Tip:**
+Starting with [GitLab Starter][ee] 9.3, this information will
+be automatically extracted and shown right in the merge request widget. To do
+so, the CI/CD job must be named `code_quality` and the artifact path must be
+`gl-code-quality-report.json`.
+[Learn more on Code Quality in merge requests](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html).
+
+CAUTION: **Caution:**
+Code Quality was previously using `codeclimate` and `codequality` for job name and
+`codeclimate.json` for the artifact name. While these old names
+are still maintained they have been deprecated with GitLab 11.0 and may be removed
+in next major release, GitLab 12.0. You are advised to update your current `.gitlab-ci.yml`
+configuration to reflect that change.
+
+[cli]: https://github.com/codeclimate/codeclimate
+[dind]: ../docker/using_docker_build.md#use-docker-in-docker-executor
+[ee]: https://about.gitlab.com/pricing/

doc/topics/autodevops/index.md

@@ -297,7 +297,7 @@ out.
 
 In GitLab Starter, differences between the source and
 target branches are also
-[shown in the merge request widget](../../user/project/merge_requests/code_quality_diff.md).
+[shown in the merge request widget](../../user/project/merge_requests/code_quality.md).
 
 ### Auto SAST **[ULTIMATE]**
 

doc/user/project/merge_requests/code_quality.md

+# Code Quality **[STARTER]**
+
+> [Introduced][ee-1984] in [GitLab Starter][ee] 9.3.
+
+## Overview
+
+If you are using [GitLab CI/CD][ci], you can analyze your source code quality
+using GitLab Code Quality. Code Quality uses [Code Climate Engines][cc], which are
+free and open source. Code Quality doesn’t require a Code Climate subscription.
+
+Going a step further, GitLab Code Quality can show the Code Climate report right
+in the merge request widget area:
+
+![Code Quality Widget][quality-widget]
+
+## Use cases
+
+For instance, consider the following workflow:
+
+1. Your backend team member starts a new implementation for making certain feature in your app faster
+1. With Code Quality reports, they analyze how their implementation is impacting the code quality
+1. The metrics show that their code degrade the quality in 10 points
+1. You ask a co-worker to help them with this modification
+1. They both work on the changes until Code Quality report displays no degradations, only improvements
+1. You approve the merge request and authorize its deployment to staging
+1. Once verified, their changes are deployed to production
+
+## How it works
+
+In order for the report to show in the merge request, you need to specify a
+`code_quality` job (exact name) that will analyze the code and upload the resulting
+`gl-code-quality-report.json` as an artifact. GitLab will then check this file and show
+the information inside the merge request.
+
+>**Note:**
+If the Code Climate report doesn't have anything to compare to, no information
+will be displayed in the merge request area. That is the case when you add the
+`code_quality` job in your `.gitlab-ci.yml` for the very first time.
+Consecutive merge requests will have something to compare to and the code quality
+report will be shown properly.
+
+For more information on how the `code_quality` job should look like, check the
+example on [analyzing a project's code quality with Code Climate CLI][cc-docs].
+
+CAUTION: **Caution:**
+Code Quality was previously using `codeclimate` and `codequality` for job name and
+`codeclimate.json` for the artifact name. While these old names
+are still maintained they have been deprecated with GitLab 11.0 and may be removed
+in next major release, GitLab 12.0. You are advised to update your current `.gitlab-ci.yml`
+configuration to reflect that change.
+
+[ee-1984]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1984
+[ee]: https://about.gitlab.com/pricing/
+[ci]: ../../../ci/README.md
+[cc]: https://codeclimate.com
+[cd]: https://hub.docker.com/r/codeclimate/codeclimate/
+[quality-widget]: img/code_quality.gif
+[cc-docs]: ../../../ci/examples/code_climate.md

doc/user/project/merge_requests/code_quality_diff.md

-# Code Quality **[STARTER]**
+---
+redirect_from: 'https://docs.gitlab.com/ee/user/project/merge_requests/code_quality_diff.html'
+redirect_to: 'code_quality.md'
+---
 
-> [Introduced][ee-1984] in [GitLab Starter][ee] 9.3.
-
-## Overview
-
-If you are using [GitLab CI/CD][ci], you can analyze your source code quality
-using GitLab Code Quality. Code Quality uses [Code Climate Engines][cc], which are
-free and open source. Code Quality doesn’t require a Code Climate subscription.
-
-Going a step further, GitLab Code Quality can show the Code Climate report right
-in the merge request widget area:
-
-![Code Quality Widget][quality-widget]
-
-## Use cases
-
-For instance, consider the following workflow:
-
-1. Your backend team member starts a new implementation for making certain feature in your app faster
-1. With Code Quality reports, they analyze how their implementation is impacting the code quality
-1. The metrics show that their code degrade the quality in 10 points
-1. You ask a co-worker to help them with this modification
-1. They both work on the changes until Code Quality report displays no degradations, only improvements
-1. You approve the merge request and authorize its deployment to staging
-1. Once verified, their changes are deployed to production
-
-## How it works
-
-In order for the report to show in the merge request, you need to specify a
-`code_quality` job (exact name) that will analyze the code and upload the resulting
-`gl-code-quality-report.json` as an artifact. GitLab will then check this file and show
-the information inside the merge request.
-
->**Note:**
-If the Code Climate report doesn't have anything to compare to, no information
-will be displayed in the merge request area. That is the case when you add the
-`code_quality` job in your `.gitlab-ci.yml` for the very first time.
-Consecutive merge requests will have something to compare to and the code quality
-report will be shown properly.
-
-For more information on how the `code_quality` job should look like, check the
-example on [analyzing a project's code quality with Code Climate CLI][cc-docs].
-
-CAUTION: **Caution:**
-Code Quality was previously using `codeclimate` and `codequality` for job name and
-`codeclimate.json` for the artifact name. While these old names
-are still maintained they have been deprecated with GitLab 11.0 and may be removed
-in next major release, GitLab 12.0. You are advised to update your current `.gitlab-ci.yml`
-configuration to reflect that change.
-
-[ee-1984]: https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1984
-[ee]: https://about.gitlab.com/pricing/
-[ci]: ../../../ci/README.md
-[cc]: https://codeclimate.com
-[cd]: https://hub.docker.com/r/codeclimate/codeclimate/
-[quality-widget]: img/code_quality.gif
-[cc-docs]: ../../../ci/examples/code_climate.md
+This document was moved to [another location](code_quality.md).

doc/user/project/merge_requests/index.md

@@ -35,7 +35,7 @@ With **[GitLab Enterprise Edition][ee]**, you can also:
 
 - View the deployment process across projects with [Multi-Project Pipelines](../../../ci/multi_project_pipelines.md#multi-project-pipeline-graphs) **[PREMIUM]**
 - Request [approvals](merge_request_approvals.md) from your managers **[STARTER]**
-- Analyze the impact of your changes with [Code Quality reports](code_quality_diff.md) **[STARTER]**
+- Analyze the impact of your changes with [Code Quality reports](code_quality.md) **[STARTER]**
 - Manage the licenses of your dependencies with [License Management](#license-management) **[ULTIMATE]**
 - Analyze your source code for vulnerabilities with [Static Application Security Testing](sast.md) **[ULTIMATE]**
 - Analyze your running web applications for vulnerabilities with [Dynamic Application Security Testing](dast.md) **[ULTIMATE]**
@@ -49,7 +49,7 @@ A. Consider you are a software developer working in a team:
 
 1. You checkout a new branch, and submit your changes through a merge request
 1. You gather feedback from your team
-1. You work on the implementation optimizing code with [Code Quality reports](code_quality_diff.md) **[STARTER]**
+1. You work on the implementation optimizing code with [Code Quality reports](code_quality.md) **[STARTER]**
 1. You avoid using dependencies whose license is not compatible with your project with [License Management reports](license_management.md) **[ULTIMATE]**
 1. You build and test your changes with GitLab CI/CD
 1. You request the [approval](#merge-request-approvals) from your manager
@@ -237,7 +237,7 @@ If you are using [GitLab CI][ci], you can analyze your source code quality using
 the [Code Climate][cc] analyzer [Docker image][cd]. Going a step further, GitLab
 can show the Code Climate report right in the merge request widget area.
 
-[Read more about Code Quality reports.](code_quality_diff.md)
+[Read more about Code Quality reports.](code_quality.md)
 
 ## Browser Performance Testing **[PREMIUM]**
 
@@ -253,7 +253,7 @@ GitLab runs the [Sitespeed.io container][sitespeed-container] and displays the d
 
 > Introduced in [GitLab Ultimate][products] 11.0.
 
-If you are using [GitLab CI/CD][ci], you can search your dependencies for their 
+If you are using [GitLab CI/CD][ci], you can search your dependencies for their
 licenses using License Management.
 Going a step further, GitLab can show the licenses report right in the
 merge request widget area.