aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-docs
diff options
context:
space:
mode:
authorStas Vilchik <stas.vilchik@sonarsource.com>2018-04-25 13:54:16 +0200
committerSonarTech <sonartech@sonarsource.com>2018-05-03 20:20:50 +0200
commit4c2edb7abdb283c6bed56ce6be32304f67529045 (patch)
tree45835a2040670502953df94725fbee4768440e89 /server/sonar-docs
parente43f918b5fc85a8b13cf966a9c23bd7d9f344fb5 (diff)
downloadsonarqube-4c2edb7abdb283c6bed56ce6be32304f67529045.tar.gz
sonarqube-4c2edb7abdb283c6bed56ce6be32304f67529045.zip
SONAR-10611 Display inline documentation tooltips (#180)
Diffstat (limited to 'server/sonar-docs')
-rw-r--r--server/sonar-docs/src/tooltips/quality-gates/built-in-quality-gate.md1
-rw-r--r--server/sonar-docs/src/tooltips/quality-gates/default-quality-gate.md1
-rw-r--r--server/sonar-docs/src/tooltips/quality-gates/project-homepage-quality-gate.md1
-rw-r--r--server/sonar-docs/src/tooltips/quality-gates/quality-gate-conditions.md5
-rw-r--r--server/sonar-docs/src/tooltips/quality-gates/quality-gate-projects.md1
-rw-r--r--server/sonar-docs/src/tooltips/quality-gates/quality-gate.md1
-rw-r--r--server/sonar-docs/src/tooltips/quality-profiles/built-in-quality-profile.md1
-rw-r--r--server/sonar-docs/src/tooltips/quality-profiles/default-quality-profile.md1
-rw-r--r--server/sonar-docs/src/tooltips/quality-profiles/quality-profile-projects.md1
-rw-r--r--server/sonar-docs/src/tooltips/rules/custom-rule-removal.md1
-rw-r--r--server/sonar-docs/src/tooltips/rules/custom-rules.md1
-rw-r--r--server/sonar-docs/src/tooltips/rules/rule-templates.md1
-rw-r--r--server/sonar-docs/src/tooltips/rules/rules-quality-profiles.md5
13 files changed, 21 insertions, 0 deletions
diff --git a/server/sonar-docs/src/tooltips/quality-gates/built-in-quality-gate.md b/server/sonar-docs/src/tooltips/quality-gates/built-in-quality-gate.md
new file mode 100644
index 00000000000..7d5470bd4da
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-gates/built-in-quality-gate.md
@@ -0,0 +1 @@
+Built-in, immutable Quality Gate reflecting best practices.
diff --git a/server/sonar-docs/src/tooltips/quality-gates/default-quality-gate.md b/server/sonar-docs/src/tooltips/quality-gates/default-quality-gate.md
new file mode 100644
index 00000000000..2cf1296dc53
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-gates/default-quality-gate.md
@@ -0,0 +1 @@
+The Default gate is applied to all projects not explicitly assigned to a gate. Quality Profile and Gate administrators can assign projects to a gate from the Quality Profile page. Project administrators can also choose a non-default gate.
diff --git a/server/sonar-docs/src/tooltips/quality-gates/project-homepage-quality-gate.md b/server/sonar-docs/src/tooltips/quality-gates/project-homepage-quality-gate.md
new file mode 100644
index 00000000000..115b34f419a
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-gates/project-homepage-quality-gate.md
@@ -0,0 +1 @@
+A Quality Gate is a set of measure-based Boolean conditions. It helps you know immediately whether your project is production-ready. If your current status is not Passed, you'll see which values caused the problem and the value required to pass.
diff --git a/server/sonar-docs/src/tooltips/quality-gates/quality-gate-conditions.md b/server/sonar-docs/src/tooltips/quality-gates/quality-gate-conditions.md
new file mode 100644
index 00000000000..e961eeb17f6
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-gates/quality-gate-conditions.md
@@ -0,0 +1,5 @@
+For each Quality Gate condition you must choose the metric to be tested, the threshold at which to raise a warning or error, and whether or not to apply the condition to all code or only to Leak Period code (irrelevant for conditions "on New Code").
+
+---
+
+See also: [Fixing the Water Leak](/fixing-the-water-leak)
diff --git a/server/sonar-docs/src/tooltips/quality-gates/quality-gate-projects.md b/server/sonar-docs/src/tooltips/quality-gates/quality-gate-projects.md
new file mode 100644
index 00000000000..2cf1296dc53
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-gates/quality-gate-projects.md
@@ -0,0 +1 @@
+The Default gate is applied to all projects not explicitly assigned to a gate. Quality Profile and Gate administrators can assign projects to a gate from the Quality Profile page. Project administrators can also choose a non-default gate.
diff --git a/server/sonar-docs/src/tooltips/quality-gates/quality-gate.md b/server/sonar-docs/src/tooltips/quality-gates/quality-gate.md
new file mode 100644
index 00000000000..0762cbcbcaa
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-gates/quality-gate.md
@@ -0,0 +1 @@
+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.
diff --git a/server/sonar-docs/src/tooltips/quality-profiles/built-in-quality-profile.md b/server/sonar-docs/src/tooltips/quality-profiles/built-in-quality-profile.md
new file mode 100644
index 00000000000..5c0ddbf1f2c
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-profiles/built-in-quality-profile.md
@@ -0,0 +1 @@
+Built-in profiles are provided directly by the language analyzers and may be updated with each new analyzer version. They represent best-practice, minimum rule sets.
diff --git a/server/sonar-docs/src/tooltips/quality-profiles/default-quality-profile.md b/server/sonar-docs/src/tooltips/quality-profiles/default-quality-profile.md
new file mode 100644
index 00000000000..310164c8be5
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-profiles/default-quality-profile.md
@@ -0,0 +1 @@
+For each language there is a default profile. All projects not explicitly assigned to some other profile will be analyzed with the default.
diff --git a/server/sonar-docs/src/tooltips/quality-profiles/quality-profile-projects.md b/server/sonar-docs/src/tooltips/quality-profiles/quality-profile-projects.md
new file mode 100644
index 00000000000..0c96fe0fb64
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/quality-profiles/quality-profile-projects.md
@@ -0,0 +1 @@
+Projects assigned to a profile will always be analyzed with it for that language, regardless of which profile is the default. Quality Profile administrators may assign projects to a profile. Project administrators may also choose a non-default profile for each language.
diff --git a/server/sonar-docs/src/tooltips/rules/custom-rule-removal.md b/server/sonar-docs/src/tooltips/rules/custom-rule-removal.md
new file mode 100644
index 00000000000..c8d9be85acd
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/rules/custom-rule-removal.md
@@ -0,0 +1 @@
+Only custom rules may be deleted. When a custom rule is deleted, it is not removed from the SonarQube instance. Instead its status is set to "REMOVED", allowing relevant issues to continue to be displayed properly.
diff --git a/server/sonar-docs/src/tooltips/rules/custom-rules.md b/server/sonar-docs/src/tooltips/rules/custom-rules.md
new file mode 100644
index 00000000000..37981a7dffb
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/rules/custom-rules.md
@@ -0,0 +1 @@
+Custom rules are created by administrators from templates, and are the only fully-editable rules.
diff --git a/server/sonar-docs/src/tooltips/rules/rule-templates.md b/server/sonar-docs/src/tooltips/rules/rule-templates.md
new file mode 100644
index 00000000000..582e4cf24be
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/rules/rule-templates.md
@@ -0,0 +1 @@
+Rule Templates allow users to easily define their own rules. They are like cookie cutters from which you can stamp out new, "custom rules". The rules created from a template are listed on its rule detail page.
diff --git a/server/sonar-docs/src/tooltips/rules/rules-quality-profiles.md b/server/sonar-docs/src/tooltips/rules/rules-quality-profiles.md
new file mode 100644
index 00000000000..809df1df132
--- /dev/null
+++ b/server/sonar-docs/src/tooltips/rules/rules-quality-profiles.md
@@ -0,0 +1,5 @@
+Quality Profiles are collections of Rules to apply during an analysis.
+
+---
+
+See also: [Quality Profiles](/quality-profiles)