aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormichaelbirnstiehl <michael.birnstiehl@sonarsource.com>2021-11-14 18:06:01 -0600
committersonartech <sonartech@sonarsource.com>2021-11-16 20:03:55 +0000
commitc908fec722157ae80fea2a323f6dcc64a306c6bb (patch)
tree12633cc920cc6826c930c6aaab9c83577bd87128
parent181461fd642c1d1505ce90465cba46ce5b221425 (diff)
downloadsonarqube-c908fec722157ae80fea2a323f6dcc64a306c6bb.tar.gz
sonarqube-c908fec722157ae80fea2a323f6dcc64a306c6bb.zip
SONAR-15618 Update Portfolio documentation on permissions and sub-portfolios
-rw-r--r--server/sonar-docs/src/pages/project-administration/managing-portfolios.md30
-rw-r--r--server/sonar-docs/src/pages/user-guide/applications.md3
2 files changed, 13 insertions, 20 deletions
diff --git a/server/sonar-docs/src/pages/project-administration/managing-portfolios.md b/server/sonar-docs/src/pages/project-administration/managing-portfolios.md
index 6f7f68196ec..2b33a92689d 100644
--- a/server/sonar-docs/src/pages/project-administration/managing-portfolios.md
+++ b/server/sonar-docs/src/pages/project-administration/managing-portfolios.md
@@ -8,28 +8,24 @@ url: /project-administration/managing-portfolios/
This page has information on managing and setting up Portfolios. For a general overview of Portfolios, see the [Portfolios](/user-guide/portfolios/) page in the User Guide.
## Permissions
-Global Administrators and users with the **Create Portfolios** permission can add and edit Portfolios.
-### Create Portfolios Permission
+### Creating Portfolios
+Users with the Create Portfolios permission and global administrators can create Portfolios:
-Users with the Create Portfolios permission (granted at the global level at [Administration > Security > Global Permissions](/#sonarqube-admin#/admin/permissions)) can create Portfolios by clicking the **Create Portfolio** button in the upper-right corner of the **Portfolios** homepage.
+* **Create Portfolios permission** – Users with the Create Portfolios permission (granted at the global level at **Administration > Security > Global Permissions**) can create Portfolios by clicking the **Create Portfolio** button in the upper-right corner of the Portfolios homepage.
+* **Global Administrators** – In addition to creating Portfolios from the Portfolios homepage, global administrators (with the global Administer System permission granted at [**Administration > Security > Global Permissions**](/#sonarqube-admin#/admin/permissions)) create portfolios from the overall Portfolio administration interface at **Administration > Configuration > Portfolios**.
-These users can also edit an individual Portfolio definition from the Portfolio-level **Portfolio Settings > Edit Definition** interface.
-
-### Global Administrators
-
-In addition to the access granted to users with the Create Portfolios permission, Global Administrators have access to the overall Portfolio and Application administration interface at **[Administration > Configuration > Portfolios](/#sonarqube-admin#/admin/extension/governance/views_console)**. From this page, they can create and edit Portfolios.
-
-Global Administrators also have access to the Projects Management page at **[Administration > Projects > Management](/#sonarqube-admin#/admin/projects_management)**. Selecting **Portfolios** from the first drop-down menu lets you manage the Portfolios or Applications of your SonarQube instance. The drop-down menu to the right of each item lets you edit permissions, apply Permission Templates or restore access to a Portfolio or Application.
+### Editing Portfolios
+Users need to have either **Administer** permissions for any Portfolios that they want to edit or the global **Administer System** permission.
## Populating Portfolios
-After you've created a portfolio, you can populate it with projects, applications, and sub-portfolios.
+After you've created a portfolio, you can populate it with projects, applications, and other portfolios.
-### Adding a Sub-portfolio
-To add a sub-portfolio, from **[Administration > Configuration > Portfolios](/#sonarqube-admin#/admin/extension/governance/views_console)** click the **Add Portfolio** button at the top of the third column, and choose:
+### Adding another Portfolio to a Portfolio
+To add another Portfolio to your Portfolio, from **[Administration > Configuration > Portfolios](/#sonarqube-admin#/admin/extension/governance/views_console)** click the **Add Portfolio** button at the top of the third column, and choose:
-* **Standard** - This option allows you to create a new sub-Portfolio from scratch. Once created, you can add projects, applications, and more layers of sub-portfolios.
-* **Local Reference** - This option allows you to reference an existing Portfolio/Application as a sub-portfolio. Once added, it is not editable here, but must be chosen in the left-most column to be edited.
+* **Standard** - This option allows you to create a new Portfolio from scratch and add it to the currently selected Portfolio. Once created, you can add projects, applications, and more layers of portfolios.
+* **Local Reference** - This option allows you to reference an existing Portfolio in the currently selected Portfolio. Once added, it is not editable here, but must be chosen in the left-most column to be edited.
### Adding a project to a Portfolio
To add projects to a Portfolio, navigate to the Portfolio you want to add a project to. Select **Edit Definition** from **Portfolio Settings**. Click the pencil icon next to **Project selection mode**, and select one of the following options:
@@ -37,7 +33,7 @@ To add projects to a Portfolio, navigate to the Portfolio you want to add a proj
* **Manual** – choose the projects individually.
* **Tags** - select one or more project tags. Projects with those tags will automatically be included in the Portfolio.
* **Regular Expression** – specify a regular expression and projects with a matching name OR key will be included.
-* **All Projects** – choose this option to add all projects not already included in this Portfolio (directly or via sub-Portfolio).
+* **All Projects** – choose this option to add all projects not already included in this Portfolio (directly or via -Portfolio).
By default, adding a project to a portfolio shows the analysis of the project's main branch. See the following section if you want to select a non-main branch or multiple branches for your project.
@@ -71,7 +67,7 @@ To add an Application to a Portfolio, make sure your Application is [already cre
[[info]]
|**Project unicity under a portfolio**<br/><br/>
-|Projects, applications, and sub-portfolios can only appear once in any given hierarchy in order to avoid magnifying their impacts on aggregated ratings. The portfolio configuration interface has some logic to prevent obvious duplications (e.g. manually adding the same project), however in case of more subtle duplications (for example, due to regular expression or other bulk definition), then the calculation of that portfolio will fail with a helpful error message.
+|Projects, applications, and portfolios can only appear once in any given hierarchy in order to avoid magnifying their impacts on aggregated ratings. The portfolio configuration interface has some logic to prevent obvious duplications (e.g. manually adding the same project), however in case of more subtle duplications (for example, due to regular expression or other bulk definition), then the calculation of that portfolio will fail with a helpful error message.
## Calculation
By default, Portfolios are queued to be recalculated after each analysis of an included project. For each relevant Portfolio, a “Background Task” is created, and you can follow the progress on each in the **[Administration > Projects > Background Tasks](/#sonarqube-admin#/admin/background_tasks)** by looking at the logs available for each item.
diff --git a/server/sonar-docs/src/pages/user-guide/applications.md b/server/sonar-docs/src/pages/user-guide/applications.md
index 4aef6b93347..64fa70f5702 100644
--- a/server/sonar-docs/src/pages/user-guide/applications.md
+++ b/server/sonar-docs/src/pages/user-guide/applications.md
@@ -21,9 +21,6 @@ Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enter
For more information on setting up Applications, see [Managing Applications](/project-administration/managing-applications/).
-[[info]]
-|Applications must be created initially by a user with global administration rights, but after set-up, administration of an individual Application can be delegated to other users.
-
### Populating Application Data
An Application is automatically re-calculated after each analysis of one of its projects. If you want immediate (re)calculation, a user with administration rights on the Application can use the **Recompute** button in the Application-level **Application Settings > Edit Definition** interface.