From: G. Ann Campbell Date: Wed, 25 Jul 2018 18:32:19 +0000 (-0400) Subject: Update docs X-Git-Tag: 7.5~691 X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=ab9ab067e29e12bad85bf7faa3b62ef7bdc8e9bb;p=sonarqube.git Update docs --- diff --git a/server/sonar-docs/src/images/recommended-quality-gate.png b/server/sonar-docs/src/images/recommended-quality-gate.png deleted file mode 100644 index fc82647ed5c..00000000000 Binary files a/server/sonar-docs/src/images/recommended-quality-gate.png and /dev/null differ diff --git a/server/sonar-docs/src/pages/quality-gates.md b/server/sonar-docs/src/pages/quality-gates.md index 65d84dc12b4..49fc7529a4b 100644 --- a/server/sonar-docs/src/pages/quality-gates.md +++ b/server/sonar-docs/src/pages/quality-gates.md @@ -19,7 +19,7 @@ Ideally, all projects will be verified against the same quality gate, but that's * You want to ensure stronger requirements on some of your applications (internal frameworks for example). * Etc. -Which is why you can define as many quality gates as you wish. Quality Gates are defined and managed in the **Quality Gates** page found in the top menu. +Which is why you can define as many quality gates as you wish. Quality Gates are defined and managed in the **[Quality Gates](/#sonarqube#/quality_gates)** page found in the top menu. ## Use the Best Quality Gate Configuration @@ -31,7 +31,7 @@ Don't forget also that quality gate conditions must use differential values. The ### Recommended Quality Gate -![Recommended Quality Gate](/images/recommended-quality-gate.png) +The `Sonar way` Built-in quality gate is recommended for most projects. If focuses on keeping new code clean, rather than spending a lot of effort remediating old code. Out of the box, it's already set as the default profile. ## Quality Gate Status @@ -53,7 +53,7 @@ A **project administrator** can choose which quality gates his/her project is as ## Defining Quality Gates -To manage quality gates, go to **Quality Gates** (top menu bar). +To manage quality gates, go to **[Quality Gates](/#sonarqube#/quality_gates)** (top menu bar). Each Quality Gate condition is a combination of: diff --git a/server/sonar-docs/src/tooltips/branches/single-branch.md b/server/sonar-docs/src/tooltips/branches/single-branch.md index c4184a27de5..4b423977294 100644 --- a/server/sonar-docs/src/tooltips/branches/single-branch.md +++ b/server/sonar-docs/src/tooltips/branches/single-branch.md @@ -4,4 +4,5 @@ Quickly setup branch analysis and get separate insights for each of your branche --- -[Branches Documentation](/branches/index) +[Branches Documentation](/branches/index) +[Pull Request Analysis](/analysis/pull-request) diff --git a/server/sonar-docs/src/tooltips/quality-gates/metric.md b/server/sonar-docs/src/tooltips/quality-gates/metric.md new file mode 100644 index 00000000000..0fe78f2edf1 --- /dev/null +++ b/server/sonar-docs/src/tooltips/quality-gates/metric.md @@ -0,0 +1,5 @@ +Metrics are code qualities that can be measured, such as the number of Bugs in New Code. Under best practice, you should prefer "new code" conditions. + +--- + +See also: [Metric definitions](/metric-definitions) diff --git a/server/sonar-docs/src/tooltips/quality-gates/quality-gate.md b/server/sonar-docs/src/tooltips/quality-gates/quality-gate.md index 0762cbcbcaa..b4f6fda8a85 100644 --- a/server/sonar-docs/src/tooltips/quality-gates/quality-gate.md +++ b/server/sonar-docs/src/tooltips/quality-gates/quality-gate.md @@ -1 +1,4 @@ A Quality Gate is a set of measure-based, Boolean conditions. It helps you know immediately whether your projects are production-ready. Ideally, all projects will use the same quality gate. Each project's Quality Gate status is displayed prominently on its homepage. + +--- +[Learn more](/quality-gates) diff --git a/server/sonar-web/src/main/js/apps/background-tasks/components/Header.tsx b/server/sonar-web/src/main/js/apps/background-tasks/components/Header.tsx index 2dff4c62785..93fe91a4435 100644 --- a/server/sonar-web/src/main/js/apps/background-tasks/components/Header.tsx +++ b/server/sonar-web/src/main/js/apps/background-tasks/components/Header.tsx @@ -18,6 +18,7 @@ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. */ import * as React from 'react'; +import { Link } from 'react-router'; import Workers from './Workers'; import { translate } from '../../../helpers/l10n'; @@ -34,7 +35,15 @@ export default function Header(props: Props) { )} -

{translate('background_tasks.page.description')}

+

+ {translate('background_tasks.page.description')} + + {translate('learn_more')} + +

); }