diff options
Diffstat (limited to 'server/sonar-docs/src/pages')
14 files changed, 18 insertions, 18 deletions
diff --git a/server/sonar-docs/src/pages/analysis/languages/cobol.md b/server/sonar-docs/src/pages/analysis/languages/cobol.md index 3f511c3eaf8..923e31e356c 100644 --- a/server/sonar-docs/src/pages/analysis/languages/cobol.md +++ b/server/sonar-docs/src/pages/analysis/languages/cobol.md @@ -249,7 +249,7 @@ To get started, clone the sample plugin project and follow the steps below: - Add your newly created jar into the `$SONARQUBE_HOME/extensions/plugins` directory - Restart the SonarQube server -If you now look at the COBOL quality profiles, you will find the new coding rule (“Sample check”). Don’t forget to activate it. Run an analysis of a COBOL project, and you will find that an issue was logged at line 5 on every file. +If you now look at the COBOL Quality Profiles, you will find the new coding rule (“Sample check”). Don’t forget to activate it. Run an analysis of a COBOL project, and you will find that an issue was logged at line 5 on every file. ### Subscribing to a NodeType diff --git a/server/sonar-docs/src/pages/analysis/languages/php.md b/server/sonar-docs/src/pages/analysis/languages/php.md index ca069f02df1..05101a333f0 100644 --- a/server/sonar-docs/src/pages/analysis/languages/php.md +++ b/server/sonar-docs/src/pages/analysis/languages/php.md @@ -14,7 +14,7 @@ Discover and update the PHP-specific [properties](/analysis/analysis-parameters/ ## Analyze php.ini Files -The PHP analyzer can analyze `php.ini` files with some specific rules (if these rules are activated in your quality profile). `php.ini` files must be part of the project you are analyzing, meaning the `php.ini` files have to be inside the directories listed in `sonar.sources`. +The PHP analyzer can analyze `php.ini` files with some specific rules (if these rules are activated in your Quality Profile). `php.ini` files must be part of the project you are analyzing, meaning the `php.ini` files have to be inside the directories listed in `sonar.sources`. Rules targeting `php.ini` files can be quickly identified through the ["php-ini"](https://rules.sonarsource.com/php/tag/php-ini) tag set on them. <!-- sonarqube --> diff --git a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-msbuild.md b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-msbuild.md index 598309c4f43..c65b9ad2471 100644 --- a/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-msbuild.md +++ b/server/sonar-docs/src/pages/analysis/scan/sonarscanner-for-msbuild.md @@ -89,7 +89,7 @@ Notes: ## Analysis steps ### Begin -The begin step is executed when you add the `begin` command line argument. It hooks into the MSBuild pipeline, downloads SonarQube quality profiles and settings and prepares your project for the analysis. +The begin step is executed when you add the `begin` command line argument. It hooks into the MSBuild pipeline, downloads SonarQube Quality Profiles and settings and prepares your project for the analysis. Command Line Parameters: @@ -107,7 +107,7 @@ For detailed information about all available parameters, see [Analysis Parameter [[warning]] | The "begin" step will modify your build like this: -| * the active `CodeAnalysisRuleSet` will be updated to match the SonarQube quality profile +| * the active `CodeAnalysisRuleSet` will be updated to match the SonarQube Quality Profile | * `WarningsAsErrors` will be turned off | | If your build process cannot tolerate these changes we recommend creating a second build job for SonarQube analysis. diff --git a/server/sonar-docs/src/pages/branches/overview.md b/server/sonar-docs/src/pages/branches/overview.md index 63f3e164938..83c2660114f 100644 --- a/server/sonar-docs/src/pages/branches/overview.md +++ b/server/sonar-docs/src/pages/branches/overview.md @@ -15,7 +15,7 @@ This is the default branch and typically corresponds to what's being developed f ### Settings and Quality Profiles on Branches -Branch settings and quality profiles are the same as those set for the master branch, and by design, it's not possible to configure other values. The New Code Period is the only exception to this as it can be set on a branch-by-branch basis. +Branch settings and Quality Profiles are the same as those set for the master branch, and by design, it's not possible to configure other values. The New Code Period is the only exception to this as it can be set on a branch-by-branch basis. ### New Code diff --git a/server/sonar-docs/src/pages/instance-administration/notifications.md b/server/sonar-docs/src/pages/instance-administration/notifications.md index 43563dc077c..d53609184af 100644 --- a/server/sonar-docs/src/pages/instance-administration/notifications.md +++ b/server/sonar-docs/src/pages/instance-administration/notifications.md @@ -10,7 +10,7 @@ To set the frequency with which the notification queue is processed, set `the so Only users who subscribe themselves will get notifications. With only one exception, there is no admin functionality to proactively subscribe another user. If you believe a user should be receiving notifications, then it's time to practice the gentle art of persuasion. ### The exception -Notifications will automatically (without user opt-in) be sent to users with Quality Profile Administration rights when built-in quality profiles are updated. These updates can only happen via an upgrade of the relevant analyzer. This type of notification is on by default, and can be toggled globally in **[Administration > General Settings > General](/#sonarqube-admin#/admin/settings/)**. +Notifications will automatically (without user opt-in) be sent to users with Quality Profile Administration rights when built-in Quality Profiles are updated. These updates can only happen via an upgrade of the relevant analyzer. This type of notification is on by default, and can be toggled globally in **[Administration > General Settings > General](/#sonarqube-admin#/admin/settings/)**. ## Email Configuration To configure the email server, go to **[Administration > General Settings > Email](/#sonarqube-admin#/admin/settings)**. diff --git a/server/sonar-docs/src/pages/instance-administration/security.md b/server/sonar-docs/src/pages/instance-administration/security.md index 84619a73708..957843740d8 100644 --- a/server/sonar-docs/src/pages/instance-administration/security.md +++ b/server/sonar-docs/src/pages/instance-administration/security.md @@ -132,7 +132,7 @@ Two groups have a special meaning: To set global permissions, log in as a System administrator and go to **[Administration > Security > Global Permissions](/#sonarqube-admin#/admin/permissions)**. * **Administer System**: All administration functions for the instance: global configuration. -* **Administer Quality Profiles**: Any action on quality profiles. +* **Administer Quality Profiles**: Any action on Quality Profiles. * **Administer Quality Gates**: Any action on quality gates * **Execute Analysis**: Execute analyses (project, view, report, developer), and to get all settings required to perform the analysis, even the secured ones like the scm account password, and so on. * **Create Projects**: Initialize the structure of a new project before its first analysis. This permission is also required when doing the very first analysis of a project that has not already been created via the GUI. * ** diff --git a/server/sonar-docs/src/pages/project-administration/managing-project-history.md b/server/sonar-docs/src/pages/project-administration/managing-project-history.md index c515c88110f..9ec64565704 100644 --- a/server/sonar-docs/src/pages/project-administration/managing-project-history.md +++ b/server/sonar-docs/src/pages/project-administration/managing-project-history.md @@ -8,7 +8,7 @@ One of the most powerful features of {instance} is that it shows you not just yo Typically these aren't things you need to even think about; {instance} just handles them for you. But occasionally you may need to remove a bad snapshot from a project's history or change the housekeeping algorithms. ## Managing History -Occasionally, you may need to manually delete a project snapshot, whether because the wrong quality profile was used, or because there was a problem with analysis, and so on. Note that the most recent snapshot (labeled "Last snapshot") can never be deleted. +Occasionally, you may need to manually delete a project snapshot, whether because the wrong Quality Profile was used, or because there was a problem with analysis, and so on. Note that the most recent snapshot (labeled "Last snapshot") can never be deleted. [[warning]] |**About deleting snapshots**<br/><br/> diff --git a/server/sonar-docs/src/pages/project-administration/project-existence.md b/server/sonar-docs/src/pages/project-administration/project-existence.md index 863bc695378..8a3e49ee1c5 100644 --- a/server/sonar-docs/src/pages/project-administration/project-existence.md +++ b/server/sonar-docs/src/pages/project-administration/project-existence.md @@ -6,11 +6,11 @@ url: /project-administration/project-existence/ Typically, projects are created during their first analysis and never deleted (because old software never dies). For atypical situations, there is the page at **[Administration > Projects > Management](/#sonarqube-admin#/admin/projects_management/)**, which allows you to manage project existence. ## How do I provision a project before its first analysis? -Provisioning a project allows you to declare and configure it (define permissions, set quality profiles, etc.) before running the first analysis. To be able to provision projects, you have to be logged in and be granted the Provision Projects permission. +Provisioning a project allows you to declare and configure it (define permissions, set Quality Profiles, etc.) before running the first analysis. To be able to provision projects, you have to be logged in and be granted the Provision Projects permission. To provision a new project either use the '+' menu in the top menu or if you have global administration privileges, go to **[Administration > Projects > Management](/#sonarqube-admin#/admin/projects_management/)** and click on **Create Project**. The only required information is the key and the name of your project. -Once the project is provisioned, you can configure it (define permissions, set quality profiles, etc.), and when you're finished with the configuration, you can simply run the project's first analysis. +Once the project is provisioned, you can configure it (define permissions, set Quality Profiles, etc.), and when you're finished with the configuration, you can simply run the project's first analysis. You can also provision and configure projects using the Web API. diff --git a/server/sonar-docs/src/pages/sonarcloud/organizations/manage-team.md b/server/sonar-docs/src/pages/sonarcloud/organizations/manage-team.md index a5433945969..41657136bde 100644 --- a/server/sonar-docs/src/pages/sonarcloud/organizations/manage-team.md +++ b/server/sonar-docs/src/pages/sonarcloud/organizations/manage-team.md @@ -5,9 +5,9 @@ url: /organizations/manage-team/ Members can collaborate on the projects in the organizations to which they belong. Depending on their permisssions within the organization, members can: * Analyze projects -* Manage project settings (permissions, visibility, quality profiles, ...) +* Manage project settings (permissions, visibility, Quality Profiles, ...) * Update issues -* Manage quality gates and quality profiles +* Manage quality gates and Quality Profiles * Administer the organization itself Members are managed on the "Members" page of the organization. Only organization administrators can manage members. 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? |