diff options
author | michaelbirnstiehl <michael.birnstiehl@sonarsource.com> | 2021-01-27 13:41:14 -0600 |
---|---|---|
committer | sonartech <sonartech@sonarsource.com> | 2021-02-12 20:07:13 +0000 |
commit | 9118e7e098faa72f0316053e52a385ffe3471d6c (patch) | |
tree | 4bce503ac8304153a0e437f971c32f3b9e090567 /server | |
parent | 6f1cf73f8b2242c72c560938ebbb8b01903ff132 (diff) | |
download | sonarqube-9118e7e098faa72f0316053e52a385ffe3471d6c.tar.gz sonarqube-9118e7e098faa72f0316053e52a385ffe3471d6c.zip |
SONAR-14391 Update Applications doc to include DE availability
Diffstat (limited to 'server')
-rw-r--r-- | server/sonar-docs/src/images/create_application.png | bin | 0 -> 12271 bytes | |||
-rw-r--r-- | server/sonar-docs/src/pages/project-administration/managing-application.md | 10 | ||||
-rw-r--r-- | server/sonar-docs/src/pages/project-administration/managing-portfolios.md | 2 | ||||
-rw-r--r-- | server/sonar-docs/src/pages/user-guide/applications.md | 19 |
4 files changed, 19 insertions, 12 deletions
diff --git a/server/sonar-docs/src/images/create_application.png b/server/sonar-docs/src/images/create_application.png Binary files differnew file mode 100644 index 00000000000..cf0210c4d28 --- /dev/null +++ b/server/sonar-docs/src/images/create_application.png diff --git a/server/sonar-docs/src/pages/project-administration/managing-application.md b/server/sonar-docs/src/pages/project-administration/managing-application.md index 8c2b13b784f..23db8dd0afa 100644 --- a/server/sonar-docs/src/pages/project-administration/managing-application.md +++ b/server/sonar-docs/src/pages/project-administration/managing-application.md @@ -3,20 +3,18 @@ title: Managing Applications url: /project-administration/managing-applications/ --- -*Applications are available starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html).* +*Applications are available starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html).* ## 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. - - +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 **Create Application** button in the upper-right corner of the **Projects** homepage. 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. +Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), 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. @@ -30,4 +28,4 @@ Once your Application is populated with projects, you can create application bra 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. ## Reindexing -During Elasticsearch reindexing due to disaster recovery or upgrading, Applications will become available after each Application is indexed.
\ No newline at end of file +During Elasticsearch reindexing due to disaster recovery or upgrading, Applications become available as they are indexed.
\ No newline at end of file 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 1164757a450..fb569787a75 100644 --- a/server/sonar-docs/src/pages/project-administration/managing-portfolios.md +++ b/server/sonar-docs/src/pages/project-administration/managing-portfolios.md @@ -10,7 +10,7 @@ There are two levels of users with permissions for adding and editing Portfolios ### Create Portfolios Permission -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. +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 the **Create Portfolio** button in the upper-right corner of the **Portfolios** homepage.  diff --git a/server/sonar-docs/src/pages/user-guide/applications.md b/server/sonar-docs/src/pages/user-guide/applications.md index beebebedb02..4aef6b93347 100644 --- a/server/sonar-docs/src/pages/user-guide/applications.md +++ b/server/sonar-docs/src/pages/user-guide/applications.md @@ -3,11 +3,11 @@ title: Applications url: /user-guide/applications/ --- -*Applications are available starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html).* +*Applications are available starting in [Developer Edition](https://redirect.sonarsource.com/editions/developer.html).* ## Using Applications -An Application is an aggregation of projects into a synthetic project. Assume you have a set of projects which has been split for technical reasons, but which shares a lifecycle; they interact directly in production and are always released together. With an Application, they can be treated as a single entity in {instance} with a unified Project Homepage, Issues list, Measures space, and most importantly: Quality Gate. +An Application aggregates projects into a synthetic project. Assume you have a set of projects which has been split for technical reasons, but which shares a life cycle; they interact directly in production and are always released together. With an Application, they can be treated as a single entity in {instance} with a unified Project Homepage, Issues list, Measures space, and most importantly: Quality Gate. ### Applications vs. Portfolios @@ -15,11 +15,20 @@ 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 [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. +You can create an Application by clicking the **Create Application** button in the upper-right corner of the **Projects** homepage. + +Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), you can also create and edit applications in the global Portfolio administration interface at **Administration > Configuration > Portfolios**. + +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. 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. + +Starting in [Enterprise Edition](https://redirect.sonarsource.com/editions/enterprise.html), 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 @@ -27,4 +36,4 @@ Branches are available for Applications. They allow you to aggregate branches fr **Note:** Avoid adding branches to your application that will be deleted to prevent issues with your Application status. -Once an Application has been set up, anyone with administration rights on the Application can manually create a new branch in the **Application Settings > Edit Definition** interface. Branches can also be managed from the global **Administration > Configuration > Portfolios** interface. For each Application branch you can choose which project branch should be included, or whether the project should be represented in the branch at all.
\ No newline at end of file +Once an Application has been set up, anyone with administration rights on the Application can manually create a new branch in the **Application Settings > Edit Definition** interface. In Enterprise Edition and above, you can also manage branches from the global **Administration > Configuration > Portfolios** interface. For each Application branch you can choose which project branch should be included, or whether the project should be represented in the branch at all.
\ No newline at end of file |