diff options
author | michaelbirnstiehl <michael.birnstiehl@sonarsource.com> | 2021-10-18 14:36:34 -0500 |
---|---|---|
committer | sonartech <sonartech@sonarsource.com> | 2021-10-22 20:03:28 +0000 |
commit | 5247c232418659f77570a6aac0fbb47f3f67aa20 (patch) | |
tree | 862d700ed8402ad14ae734c527952f0dcc7f1053 | |
parent | 2a4c3b3c03cc0bc8b6cd7dc0600cd016d0e9a3ae (diff) | |
download | sonarqube-5247c232418659f77570a6aac0fbb47f3f67aa20.tar.gz sonarqube-5247c232418659f77570a6aac0fbb47f3f67aa20.zip |
SONAR-15532 Document delegating Quality Gate permissions to users or groups
3 files changed, 9 insertions, 6 deletions
diff --git a/server/sonar-docs/src/pages/instance-administration/quality-profiles.md b/server/sonar-docs/src/pages/instance-administration/quality-profiles.md index 0e78f8caab4..f30858b16ef 100644 --- a/server/sonar-docs/src/pages/instance-administration/quality-profiles.md +++ b/server/sonar-docs/src/pages/instance-administration/quality-profiles.md @@ -26,11 +26,9 @@ The **Sonar way** Quality Profiles are a good starting point as you begin analyz ## Quality Profile permissions -By default, only users with the **Administer Quality Profiles** permission can edit Quality Profiles. This is set at **Administration > Security > Global Permissions**. +By default, only users with the global **Administer Quality Profiles** permission can edit Quality Profiles. This is set at **Administration > Security > Global Permissions**. -SonarQube also lets you to grant permission to users or groups for specific Quality Profiles, so you can delegate profile management to a group of experts for that language. These users or groups only have permissions for that specific profile, not all Quality Profiles. - -A user with the **Administer Quality Profiles** permission or individual edit rights for a specific Quality Profile can grant permissions on Quality Profile pages (**Quality Profiles > [ Profile Name ]**) under the **Permissions** heading. +SonarQube also allows users with the global **Administer Quality Profiles** permission to give an expert or group of experts permission to manage a specific Quality Profile. These experts only have permission for that Quality Profile, not all Quality Profiles. Grant permissions to specific Quality Profiles on the Quality Profile's page (**Quality Profiles > [Quality Profile name]**) under the **Permissions** heading by clicking the **Grant permissions to more users** button. ## Copying a Quality Profile Copying a profile works well when you need to make a few changes to a built-in profile. When you copy a profile, you start off with all of the activated rules from the profile you copied from. From here, you can activate or deactivate rules to fit your needs. After copying a profile, your new profile won't inherit any changes made to the original profile. diff --git a/server/sonar-docs/src/pages/instance-administration/security.md b/server/sonar-docs/src/pages/instance-administration/security.md index dd1e4b5cd26..829ba21f1ef 100644 --- a/server/sonar-docs/src/pages/instance-administration/security.md +++ b/server/sonar-docs/src/pages/instance-administration/security.md @@ -129,8 +129,8 @@ 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 Gates**: Any action on quality gates +* **Administer Quality Profiles**: Any action on Quality Profiles, including delegating permissions to specific Quality Profiles. +* **Administer Quality Gates**: Any action on Quality Gates, including delegating permissions to specific Quality Gates. * **Execute Analysis**: Access to all settings required to perform analysis and the ability to push analysis results to the SonarQube server. This includes private project settings but excludes secured settings like passwords. * **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. * ** * **Create Applications**: Create a new Application. * ** diff --git a/server/sonar-docs/src/pages/user-guide/quality-gates.md b/server/sonar-docs/src/pages/user-guide/quality-gates.md index 25afc6a9972..4c478eea092 100644 --- a/server/sonar-docs/src/pages/user-guide/quality-gates.md +++ b/server/sonar-docs/src/pages/user-guide/quality-gates.md @@ -21,6 +21,11 @@ Ideally, all projects will use the same quality gate, but that's not always prac Which is why you can define as many quality gates as you need. You can access the **[Quality Gates](/#sonarqube#/quality_gates)** page from the top menu. From here you can define and manage your Quality Gates. +## Quality Gate permissions +By default, only users with the global **Administer Quality Gates** permission can edit Quality Gates. This is set at **Administration > Security > Global Permissions**. + +SonarQube also allows users with the global **Administer Quality Gates** permission to give an expert or group of experts permission to manage a specific Quality Gate. These experts only have permission for that Quality Gate, not all Quality Gates. Grant permissions to specific Quality Gate on the Quality Gate's page (**Quality Gates > [Quality Gate name]**) under the **Permissions** heading by clicking the **Grant permissions to more users** button. + ## Use the best Quality Gate configuration The "Sonar way" Quality Gate is provided by SonarSource, activated by default, and considered as built-in and read-only. This Quality Gate represents the best way to implement the [Clean as You Code](/user-guide/clean-as-you-code/) concept by focusing on new code. With each SonarQube release, we automatically adjust this default quality gate according to SonarQube's capabilities. |