diff options
author | michaelbirnstiehl <michael.birnstiehl@sonarsource.com> | 2020-04-05 13:18:09 -0500 |
---|---|---|
committer | sonartech <sonartech@sonarsource.com> | 2020-04-15 20:03:38 +0000 |
commit | 39e46b040e7c7d60ade26bca89c460ce1dfec0a4 (patch) | |
tree | 9b42e5e7453df2ea12ffaaae67e5f6874e9c577c /server/sonar-docs/src/pages | |
parent | 661873873ffca37fe149bfbf1775cdda8955ea8b (diff) | |
download | sonarqube-39e46b040e7c7d60ade26bca89c460ce1dfec0a4.tar.gz sonarqube-39e46b040e7c7d60ade26bca89c460ce1dfec0a4.zip |
SONAR-13250 update docs for Apps move to project page
Diffstat (limited to 'server/sonar-docs/src/pages')
-rw-r--r-- | server/sonar-docs/src/pages/project-administration/managing-application.md | 30 | ||||
-rw-r--r-- | server/sonar-docs/src/pages/project-administration/managing-portfolios.md (renamed from server/sonar-docs/src/pages/project-administration/configuring-portfolios-and-applications.md) | 36 | ||||
-rw-r--r-- | server/sonar-docs/src/pages/user-guide/applications.md | 4 | ||||
-rw-r--r-- | server/sonar-docs/src/pages/user-guide/portfolios.md | 2 |
4 files changed, 52 insertions, 20 deletions
diff --git a/server/sonar-docs/src/pages/project-administration/managing-application.md b/server/sonar-docs/src/pages/project-administration/managing-application.md new file mode 100644 index 00000000000..c3a2494c9ba --- /dev/null +++ b/server/sonar-docs/src/pages/project-administration/managing-application.md @@ -0,0 +1,30 @@ +--- +title: Managing Applications +url: /project-administration/managing-applications/ +--- + +*Applications are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).* + +## Permissions +There are two levels of users with permissions for adding and editing Applications: users with the Create Applications permission and Global Administrators. + +### Create Applications Permission +Users with the Create Applications permission (granted at the global level at [Administration > Security > Global Permissions](/#sonarqube-admin#/admin/permissions)) can create Applications by clicking the "+" in the top menu. + +![Create Applications](/images/creatingportfoliosandapps.png) + +Users with the Create Applications permission can edit an individual Application definition from the Application-level **Portfolio Settings > Edit Definition** interface. + +### Global Administrators +In addition to the access granted to users with the Create Applications 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 Applications. + +Global Administrators also have access to the Projects Management page at **[Administration > Projects > Management](/#sonarqube-admin#/admin/projects_management)**. Changing the selection mechanism on this page to “Portfolios” or “Applications” lets you manage the Portfolios or Applications of your SonarQube instance. The dropdown menu to the right of each item lets you edit permissions, apply Permission Templates, or restore access to a Portfolio or Application. + +## Populating Applications +Once your Application exists, you can populate it with manually-selected projects. By default, the configuration interface shows the list of projects currently selected for the application. To add additional projects, choose the "Unselected" or "All" filter. + +## Creating Application Branches +Once your Application is populated with projects, you can create application branches by choosing branches from the Application's component projects. This option is available in the Application's **Application Settings > Edit Definition** interface, or from the global administration interface. + +## Calculation +By default, Applications are queued to be recalculated after each analysis of an included project. For each relevant Application, 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.
\ No newline at end of file diff --git a/server/sonar-docs/src/pages/project-administration/configuring-portfolios-and-applications.md b/server/sonar-docs/src/pages/project-administration/managing-portfolios.md index 256b13baf09..604b7f082c9 100644 --- a/server/sonar-docs/src/pages/project-administration/configuring-portfolios-and-applications.md +++ b/server/sonar-docs/src/pages/project-administration/managing-portfolios.md @@ -1,29 +1,37 @@ --- -title: Managing Portfolios and Applications -url: /project-administration/configuring-portfolios-and-applications/ +title: Managing Portfolios +url: /project-administration/managing-portfolios/ --- -*Portfolios and Applications are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).* +*Portfolios are available as part of the [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html) and [above](https://www.sonarsource.com/plans-and-pricing/).* ## Permissions -Users with the Create Portfolios or Create Applications permission have access to the creation interfaces from the "+" item in the top menu. +There are two levels of users with permissions for adding and editing Portfolios: users with the Create Portfolios permission and Global Administrators. -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, Portfolios and Applications can be created and edited. +### Create Portfolios Permission -Users of either type can edit an individual Portfolio or Application definition from the lower-level **Administration > Edit Definition** interface. +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 "+" in the top menu. + +![Create Portfolios](/images/creatingportfoliosandapps.png) + +Users with the Create Portfolios permission can 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)**. Changing the selection mechanism on this page to “Portfolios” or “Applications” lets you manage the Portfolios or Applications of your SonarQube instance. The dropdown menu to the right of each item lets you edit permissions, apply Permission Templates or restore access to a Portfolio or Application. ## Populating Portfolios -Once your Portfolio exists, you can populate it with any mix of projects, Applications, and sub-portfolios. Applications may only be populated with projects. +Once your Portfolio exists, you can populate it with any mix of projects, Applications, and sub-portfolios. -## Adding a Sub-portfolio +### Adding a Sub-portfolio To add a sub-portfolio, click on “Add Portfolio” 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. -## Adding Projects to a Portfolio +### Adding Projects to a Portfolio To add projects directly to a Portfolio or standard sub-Portfolio first make sure the correct item is selected, then choose the **Project selection mode**: * **Manual** – choose the projects individually. @@ -31,7 +39,7 @@ To add projects directly to a Portfolio or standard sub-Portfolio first make sur * **Regular Expression** – specify a regular expression and projects with a matching name OR key will be included. * **All Remaining Projects** – choose this option to add all projects not already included in this Portfolio (directly or via sub-Portfolio). -## Adding Applications to a Portfolio +### Adding Applications to a Portfolio To add an Application to a Portfolio, first make sure your Application is [already created](/user-guide/applications/). Then: 1. Navigate to the Portfolios configuration page by going to **[Administration > Configuration > Portfolios](/#sonarqube-admint#/admin/extension/governance/views_console/)**. @@ -44,13 +52,7 @@ To add an Application to a Portfolio, first make sure your Application is [alrea |**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 (e.g. due to regex, or other bulk definition), then the calculation of that portfolio will fail with a helpful error message. -## Populating Applications -Once your Application exists, you can populate it with manually-selected projects. By default, the configuration interface shows the list of projects currently selected for the application. To add additional projects, choose the "Unselected" or "All" filter. - -## Creating Application Branches -Once your Application is populated with projects, you can create application branches by choosing branches from the application's component projects. This option is available in the Application's **Administration > Edit Definition** interface, or from the global administration interface. - ## Calculation -By default, Applications and Portfolios are queued to be recalculated after each analysis of an included project. For each relevant Portfolio and Application, 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. +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. If you're having performance issues related to automatic recalculation of large portfolios, you can specify the hour(s) at which you want them to be recalculated at **[Administration > Portfolios > Recalculation](/#sonarqube-admin#/admin/settings?category=portfolios)**. Portfolios are queued to be recalculated at the beginning of the hour(s) that you specify. diff --git a/server/sonar-docs/src/pages/user-guide/applications.md b/server/sonar-docs/src/pages/user-guide/applications.md index 8d71ed4c19c..271e05d6402 100644 --- a/server/sonar-docs/src/pages/user-guide/applications.md +++ b/server/sonar-docs/src/pages/user-guide/applications.md @@ -15,11 +15,11 @@ Applications and Portfolios are both aggregations of projects, but they have dif ## Application Setup -Applications are created and edited in the global Portfolio administration interface: **Administration > Configuration > Portfolios**. For more, see [Configuring Portfolios and Applications](/project-administration/configuring-portfolios-and-applications/). 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. +Applications are created and edited in the global Portfolio administration interface: **Administration > Configuration > Portfolios**. For more, see [Managing Applications](/project-administration/managing-applications/). 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 **Administration > Edit Definition** interface. The global Portfolio administration interface: **Administration > Configuration > Portfolios** offers the ability to queue re-computation of all Applications and Portfolios at once. +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. The global Portfolio administration interface: **Administration > Configuration > Portfolios** offers the ability to queue re-computation of all Applications and Portfolios at once. ## Applications and Branch Analysis diff --git a/server/sonar-docs/src/pages/user-guide/portfolios.md b/server/sonar-docs/src/pages/user-guide/portfolios.md index de7a79f525b..36a6e79244b 100644 --- a/server/sonar-docs/src/pages/user-guide/portfolios.md +++ b/server/sonar-docs/src/pages/user-guide/portfolios.md @@ -53,4 +53,4 @@ You can subscribe to receive a PDF by email by selecting **Subscribe** from the **Note:** You will only receive the PDF if the Portfolio is computed. -Portfolios are created and edited in the global Portfolio administration interface: **Administration > Configuration > Portfolios**. For more information, see [Configuring Portfolios and Applications](/project-administration/configuring-portfolios-and-applications/). +Portfolios are created and edited in the global Portfolio administration interface: **Administration > Configuration > Portfolios**. For more information, see [Managing Portfolios](/project-administration/managing-portfolios/). |