]> source.dussan.org Git - sonarqube.git/commitdiff
Update docs
authorG. Ann Campbell <ann.campbell@sonarsource.com>
Wed, 25 Jul 2018 18:32:19 +0000 (14:32 -0400)
committerSonarTech <sonartech@sonarsource.com>
Thu, 2 Aug 2018 18:21:32 +0000 (20:21 +0200)
server/sonar-docs/src/images/recommended-quality-gate.png [deleted file]
server/sonar-docs/src/pages/quality-gates.md
server/sonar-docs/src/tooltips/branches/single-branch.md
server/sonar-docs/src/tooltips/quality-gates/metric.md [new file with mode: 0644]
server/sonar-docs/src/tooltips/quality-gates/quality-gate.md
server/sonar-web/src/main/js/apps/background-tasks/components/Header.tsx

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 (file)
index fc82647..0000000
Binary files a/server/sonar-docs/src/images/recommended-quality-gate.png and /dev/null differ
index 65d84dc12b4d2857216c014f8afffda5223015fb..49fc7529a4b74baae2a8938e1372c7c748aff26b 100644 (file)
@@ -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:
 
index c4184a27de5eaf49b614355120c2e96db997062c..4b423977294f8d1764f0a00fa9dd17609f9716e8 100644 (file)
@@ -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 (file)
index 0000000..0fe78f2
--- /dev/null
@@ -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)
index 0762cbcbcaa62a2fc1b041ccbe487974316101f6..b4f6fda8a85263f1c429e0d99d0458ce91279bf9 100644 (file)
@@ -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)
index 2dff4c6278595e0b4f38f97eaabc54d87b32c828..93fe91a443516bba2966d8d0e953684a3984d953 100644 (file)
@@ -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) {
           <Workers />
         </div>
       )}
-      <p className="page-description">{translate('background_tasks.page.description')}</p>
+      <p className="page-description">
+        {translate('background_tasks.page.description')}
+        <Link
+          className="spacer-left"
+          target="_blank"
+          to={{ pathname: '/documentation/analysis/background-tasks' }}>
+          {translate('learn_more')}
+        </Link>
+      </p>
     </header>
   );
 }