diff options
Diffstat (limited to 'server/sonar-docs/src/pages/user-guide')
5 files changed, 6 insertions, 6 deletions
diff --git a/server/sonar-docs/src/pages/user-guide/activity-history.md b/server/sonar-docs/src/pages/user-guide/activity-history.md index f7de8a7b71e..6b3e1b918e5 100644 --- a/server/sonar-docs/src/pages/user-guide/activity-history.md +++ b/server/sonar-docs/src/pages/user-guide/activity-history.md @@ -11,7 +11,7 @@ Graphs on the activity page help you understand the evolution of up to three mea There are four types of events: * Quality Gate - the status of the [quality gate](/user-guide/quality-gates/) changed. -* Profile - the [quality profile](/instance-administration/quality-profiles/) used to analyze the project changed - either the profile was edited, or a different profile was used to analyze the project. +* Profile - the [Quality Profile](/instance-administration/quality-profiles/) used to analyze the project changed - either the profile was edited, or a different profile was used to analyze the project. * Version - the project's version changed. * Other - an event was manually created on a snapshot. See [Managing History](/project-administration/managing-project-history/) diff --git a/server/sonar-docs/src/pages/user-guide/concepts.md b/server/sonar-docs/src/pages/user-guide/concepts.md index 7ee1d5368b0..2bf5a0b5ca5 100644 --- a/server/sonar-docs/src/pages/user-guide/concepts.md +++ b/server/sonar-docs/src/pages/user-guide/concepts.md @@ -21,7 +21,7 @@ url: /user-guide/concepts/ | Measure | The value of a **metric** for a given file or project at a given time. For example, 125 lines of code on class MyClass or density of duplicated lines of 30.5% on project myProject | | Metric | A type of measurement. Metrics can have varying values, or **measures**, over time. Examples: number of lines of code, complexity, etc. A metric may be either _qualitative_ (gives a quality indication on the component, E.G. density of duplicated lines, line coverage by tests, etc.) or _quantitative_ (does not give a quality indication on the component, E.G. number of lines of code, complexity, etc.) | | New Code definition | A changeset or period that you're keeping a close watch on for the introduction of new problems in the code. Ideally this is since the `previous_version`, but if you don't use a Maven-like versioning scheme you may need to set a time period such as 21 days, since a specific anaylsis, or use a reference branch. | -| Quality Profile | A set of **rules**. Each **snapshot** is based on a single quality profile. See also [Quality Profiles](/instance-administration/quality-profiles/) | +| Quality Profile | A set of **rules**. Each **snapshot** is based on a single Quality Profile. See also [Quality Profiles](/instance-administration/quality-profiles/) | | Rule | A coding standard or practice which should be followed. Not complying with coding rules leads to **Bugs**, **Vulnerabilities**, **Security Hotspots**, and **Code Smells**. Rules can check quality on code files or unit tests. | | Remediation Cost | The estimated time required to fix Vulnerability and Reliability Issues. | | Snapshot | A set of **measures** and **issues** on a given project at a given time. A snapshot is generated for each analysis. | diff --git a/server/sonar-docs/src/pages/user-guide/issues.md b/server/sonar-docs/src/pages/user-guide/issues.md index 87da00d6927..ecbbaacbb64 100644 --- a/server/sonar-docs/src/pages/user-guide/issues.md +++ b/server/sonar-docs/src/pages/user-guide/issues.md @@ -3,7 +3,7 @@ title: Issues url: /user-guide/issues/ --- -While running an analysis, {instance} raises an issue every time a piece of code breaks a coding rule. The set of coding rules is defined through the associated [quality profile](/instance-administration/quality-profiles/) for each language in the project. +While running an analysis, {instance} raises an issue every time a piece of code breaks a coding rule. The set of coding rules is defined through the associated [Quality Profile](/instance-administration/quality-profiles/) for each language in the project. ### Issue Types @@ -116,7 +116,7 @@ The Confirm, False Positive, Won't Fix, Severity change, and Resolve actions all * **Severity change** - This is the middle ground between the first two options. Yes, it's a problem, but it's not as bad a problem as the rule's default severity makes it out to be. Or perhaps it's actually far worse. Either way, you adjust the severity of the issue to bring it in line with what you feel it deserves. Requires Administer Issues permission on the project. * **Resolve** - If you think you've fixed an open issue, you can Resolve it. If you're right, the next analysis will move it to closed status. If you're wrong, its status will go to re-opened. -If you tend to mark a lot of issues False Positive or Won't Fix, it means that some coding rules are not appropriate for your context. So, you can either completely deactivate them in the quality profile or use issue exclusions to narrow the focus of the rules so they are not used on specific parts (or types of object) of your application. Similarly, making a lot of severity changes should prompt you to consider updating the rule severities in your profiles. +If you tend to mark a lot of issues False Positive or Won't Fix, it means that some coding rules are not appropriate for your context. So, you can either completely deactivate them in the Quality Profile or use issue exclusions to narrow the focus of the rules so they are not used on specific parts (or types of object) of your application. Similarly, making a lot of severity changes should prompt you to consider updating the rule severities in your profiles. As you edit issues, the related metrics (e.g. New Bugs), will update automatically, as will the Quality Gate status if it's relevant. diff --git a/server/sonar-docs/src/pages/user-guide/rules.md b/server/sonar-docs/src/pages/user-guide/rules.md index 4e200ab644a..f665f384c45 100644 --- a/server/sonar-docs/src/pages/user-guide/rules.md +++ b/server/sonar-docs/src/pages/user-guide/rules.md @@ -34,7 +34,7 @@ By default, when entering the top menu item "Rules", you will see all the availa * **Template**: display rule templates that allow to create custom rules (see later on this page). * **Quality Profile**: inclusion in or exclusion from a specific profile -If a quality profile is selected, it is also possible to check for its active severity and whether it is inherited or not. See the Quality Profile documentation for more. +If a Quality Profile is selected, it is also possible to check for its active severity and whether it is inherited or not. See the Quality Profile documentation for more. ## Rule Details diff --git a/server/sonar-docs/src/pages/user-guide/security-reports.md b/server/sonar-docs/src/pages/user-guide/security-reports.md index 40831853f82..049292a855f 100644 --- a/server/sonar-docs/src/pages/user-guide/security-reports.md +++ b/server/sonar-docs/src/pages/user-guide/security-reports.md @@ -8,7 +8,7 @@ url: /user-guide/security-reports/ ## What do Security Reports show? Security Reports quickly give you the big picture on your application's security, with breakdowns of just where you stand in regard to each of the [OWASP Top 10](https://www.owasp.org/index.php/Top_10-2017_Top_10), and [SANS Top 25](https://www.sans.org/top25-software-errors) categories, and [CWE](https://cwe.mitre.org/)-specific details. -The Security Reports are fed by the analyzers, which rely on the rules activated in your quality profiles to raise security issues. If there are no rules corresponding to a given OWASP category activated in your Quality Profile, you will get no issues linked to that specific category and the rating displayed will be A. That won't mean you are safe for that category, but that you need to activate more rules (assuming some exist). +The Security Reports are fed by the analyzers, which rely on the rules activated in your Quality Profiles to raise security issues. If there are no rules corresponding to a given OWASP category activated in your Quality Profile, you will get no issues linked to that specific category and the rating displayed will be A. That won't mean you are safe for that category, but that you need to activate more rules (assuming some exist). ## What's the difference between a Security Hotspot and a Vulnerability? |