Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-04-19 15:15:59 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-04-19 15:15:59 +0300
commit2017bc90a671eac669f0114b6ef508e151409c4f (patch)
tree79bbbedede417d3ce13ae2e13dd1ad3bb069c975 /doc
parent9450a63064cd1572f030628dbf155f5c047f28c7 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/administration/audit_events.md1
-rw-r--r--doc/integration/jira/connect-app.md84
-rw-r--r--doc/integration/jira/img/jira-upload-app-success_v13_11.pngbin11440 -> 0 bytes
-rw-r--r--doc/integration/jira/img/jira-upload-app_v13_11.pngbin20667 -> 0 bytes
-rw-r--r--doc/integration/jira/img/jira_dev_panel_setup_com_1.pngbin15392 -> 0 bytes
-rw-r--r--doc/integration/jira/img/jira_dev_panel_setup_com_2.pngbin22370 -> 0 bytes
-rw-r--r--doc/integration/jira/img/jira_dev_panel_setup_com_3_v13_9.pngbin28042 -> 0 bytes
-rw-r--r--doc/integration/jira/img/jira_dev_panel_setup_com_4_v13_9.pngbin23360 -> 0 bytes
-rw-r--r--doc/user/analytics/value_streams_dashboard.md32
9 files changed, 45 insertions, 72 deletions
diff --git a/doc/administration/audit_events.md b/doc/administration/audit_events.md
index 53630e915bb..92bd73d1a75 100644
--- a/doc/administration/audit_events.md
+++ b/doc/administration/audit_events.md
@@ -389,6 +389,7 @@ Some events are not tracked in audit events. The following epics and issues prop
- [Group settings and activity](https://gitlab.com/groups/gitlab-org/-/epics/475).
- [Instance-level settings and activity](https://gitlab.com/groups/gitlab-org/-/epics/476).
- [Deployment Approval activity](https://gitlab.com/gitlab-org/gitlab/-/issues/354782).
+- [Approval rules processing by a non GitLab user](https://gitlab.com/gitlab-org/gitlab/-/issues/407384).
If you don't see the event you want in any of the epics, you can either:
diff --git a/doc/integration/jira/connect-app.md b/doc/integration/jira/connect-app.md
index fd527bc184a..fa7d48ba44d 100644
--- a/doc/integration/jira/connect-app.md
+++ b/doc/integration/jira/connect-app.md
@@ -9,25 +9,15 @@ info: To determine the technical writer assigned to the Stage/Group associated w
With the [GitLab for Jira Cloud](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud) app,
you can integrate GitLab and Jira Cloud.
-Only Jira users with administrator access can install or configure
-the GitLab for Jira Cloud app.
-
-## Install the GitLab for Jira Cloud app **(FREE SAAS)**
-
If you use GitLab.com and Jira Cloud, you can install the GitLab for Jira Cloud app.
-If you do not use both of these environments, use the [Jira DVCS Connector](dvcs/index.md) or
-[install the GitLab for Jira Cloud app manually](#install-the-gitlab-for-jira-cloud-app-manually).
-You should use the GitLab for Jira Cloud app because data is
-synchronized in real time. The DVCS connector updates data only once per hour.
-
-To configure the GitLab for Jira Cloud app, you must have
-at least the Maintainer role in the GitLab.com namespace.
+If you do not use both of these environments, use the [Jira DVCS Connector](dvcs/index.md) instead
+or [install the GitLab for Jira Cloud app manually](#install-the-gitlab-for-jira-cloud-app-manually).
+You should use the GitLab for Jira Cloud app because data is synchronized
+in real time. The Jira DVCS connector updates data only once per hour.
This integration method supports [Smart Commits](dvcs/index.md#smart-commits).
-<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
-For an overview, see
-[Configure the GitLab for Jira Cloud app from the Atlassian Marketplace](https://youtu.be/SwR-g1s1zTo).
+## Install the GitLab for Jira Cloud app **(FREE SAAS)**
Prerequisites:
@@ -36,36 +26,27 @@ Prerequisites:
To install the GitLab for Jira Cloud app:
-1. In Jira, go to **Jira Settings > Apps > Find new apps**, then search for GitLab.
-1. Select **GitLab for Jira Cloud**, then select **Get it now**, or go to the
- [App in the marketplace directly](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud).
+1. In Jira, select **Jira Settings > Apps > Find new apps**, and search for GitLab.
+1. Select **GitLab for Jira Cloud**, and select **Get it now**.
- ![Install GitLab.com app on Jira Cloud](img/jira_dev_panel_setup_com_1.png)
-1. After installing, to go to the configurations page, select **Get started**.
- This page is always available under **Jira Settings > Apps > Manage apps**.
+ Alternatively, [get the app directly from the Atlassian Marketplace](https://marketplace.atlassian.com/apps/1221011/gitlab-com-for-jira-cloud).
- ![Start GitLab.com app configuration on Jira Cloud](img/jira_dev_panel_setup_com_2.png)
-1. To add namespaces, ensure you're signed in to GitLab.com
- as a user with at least the Maintainer role.
-
- ![Sign in to GitLab.com in GitLab for Jira Cloud app](img/jira_dev_panel_setup_com_3_v13_9.png)
+1. To go to the configurations page, select **Get started**.
+ You can always access this page in **Jira Settings > Apps > Manage apps**.
1. To open the list of available namespaces, select **Add namespace**.
+1. To link to a namespace, select **Link**.
-1. Identify the namespace you want to link, and select **Link**.
-
- ![Link namespace in GitLab for Jira Cloud app](img/jira_dev_panel_setup_com_4_v13_9.png)
-
-NOTE:
-The GitLab.com user only needs access when adding a new namespace. For syncing with
-Jira, we do not depend on the user's token.
+<i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
+For an overview, see
+[Configure the GitLab for Jira Cloud app from the Atlassian Marketplace](https://youtu.be/SwR-g1s1zTo).
After a namespace is added:
-- All future commits, branches, and merge requests of all projects under that namespace
+- All future commits, branches, and merge requests of all projects in that namespace
are synced to Jira.
-- In GitLab 13.8 and later, past merge request data is synced to Jira.
+- In GitLab 13.8 and later, existing merge request data is synced to Jira.
-For more information about syncing past branch and commit data, see [issue 263240](https://gitlab.com/gitlab-org/gitlab/-/issues/263240).
+For more information about syncing existing branch and commit data, see [issue 263240](https://gitlab.com/gitlab-org/gitlab/-/issues/263240).
## Update the GitLab for Jira Cloud app
@@ -152,13 +133,6 @@ To link your self-managed instance to the GitLab for Jira Cloud app:
If your GitLab instance is self-managed and you don't want to use the official marketplace listing,
you can install the app manually.
-### Prerequisites
-
-- The instance must be publicly available.
-- You must set up [OAuth authentication](#set-up-oauth-authentication-for-self-managed-instances).
-
-### Set up your Jira app
-
Each Jira Cloud application must be installed from a single location. Jira fetches
a [manifest file](https://developer.atlassian.com/cloud/jira/platform/connect-app-descriptor/)
from the location you provide. The manifest file describes the application to the system. To support
@@ -167,7 +141,12 @@ self-managed GitLab instances with Jira Cloud, you can do one of the following:
- [Install the application in development mode](#install-the-application-in-development-mode).
- [Create a Marketplace listing](#create-a-marketplace-listing).
-#### Install the application in development mode
+### Prerequisites
+
+- The instance must be publicly available.
+- You must set up [OAuth authentication](#set-up-oauth-authentication-for-self-managed-instances).
+
+### Install the application in development mode
See [prerequisites](#prerequisites-1).
@@ -178,21 +157,14 @@ from outside the Marketplace:
1. Place your Jira instance into
[development mode](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/#step-2--enable-development-mode).
1. Sign in to your GitLab application as a user with administrator access.
-1. Install the GitLab application from your Jira instance, as
- described in the [Atlassian developer guides](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/#step-3--install-and-test-your-app):
+1. Install the GitLab application from your Jira instance as
+ described in the [Atlassian developer guide](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/#step-3--install-and-test-your-app):
1. In your Jira instance, go to **Apps > Manage Apps** and select **Upload app**:
-
- ![Button labeled "upload app"](img/jira-upload-app_v13_11.png)
-
- 1. For **App descriptor URL**, provide the full URL to your manifest file, based
+ 1. For **App descriptor URL**, provide the full URL to your manifest file based
on your instance configuration. By default, your manifest file is located at `/-/jira_connect/app_descriptor.json`. For example, if your GitLab self-managed instance domain is `app.pet-store.cloud`, your manifest file is located at `https://app.pet-store.cloud/-/jira_connect/app_descriptor.json`.
1. Select **Upload**. Jira fetches the content of your `app_descriptor` file and installs
it.
- 1. If the upload is successful, Jira displays a modal panel: **Installed and ready to go!**
- To configure the integration, select **Get started**.
-
- ![Success modal](img/jira-upload-app-success_v13_11.png)
-
+ 1. To configure the integration, select **Get started**.
1. Disable [development mode](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/#step-2--enable-development-mode) on your Jira instance.
The **GitLab for Jira Cloud** app now displays under **Manage apps**. You can also
@@ -202,7 +174,7 @@ NOTE:
If a GitLab update makes changes to the application descriptor, you must uninstall,
then reinstall the application.
-#### Create a Marketplace listing
+### Create a Marketplace listing
If you don't want to use development mode on your Jira instance, you can create
your own Marketplace listing. This way, your application
diff --git a/doc/integration/jira/img/jira-upload-app-success_v13_11.png b/doc/integration/jira/img/jira-upload-app-success_v13_11.png
deleted file mode 100644
index c0d4c9744b6..00000000000
--- a/doc/integration/jira/img/jira-upload-app-success_v13_11.png
+++ /dev/null
Binary files differ
diff --git a/doc/integration/jira/img/jira-upload-app_v13_11.png b/doc/integration/jira/img/jira-upload-app_v13_11.png
deleted file mode 100644
index 88d1573f778..00000000000
--- a/doc/integration/jira/img/jira-upload-app_v13_11.png
+++ /dev/null
Binary files differ
diff --git a/doc/integration/jira/img/jira_dev_panel_setup_com_1.png b/doc/integration/jira/img/jira_dev_panel_setup_com_1.png
deleted file mode 100644
index 18f0d5da043..00000000000
--- a/doc/integration/jira/img/jira_dev_panel_setup_com_1.png
+++ /dev/null
Binary files differ
diff --git a/doc/integration/jira/img/jira_dev_panel_setup_com_2.png b/doc/integration/jira/img/jira_dev_panel_setup_com_2.png
deleted file mode 100644
index 31dc13e1271..00000000000
--- a/doc/integration/jira/img/jira_dev_panel_setup_com_2.png
+++ /dev/null
Binary files differ
diff --git a/doc/integration/jira/img/jira_dev_panel_setup_com_3_v13_9.png b/doc/integration/jira/img/jira_dev_panel_setup_com_3_v13_9.png
deleted file mode 100644
index fe791637d31..00000000000
--- a/doc/integration/jira/img/jira_dev_panel_setup_com_3_v13_9.png
+++ /dev/null
Binary files differ
diff --git a/doc/integration/jira/img/jira_dev_panel_setup_com_4_v13_9.png b/doc/integration/jira/img/jira_dev_panel_setup_com_4_v13_9.png
deleted file mode 100644
index 08787f12b67..00000000000
--- a/doc/integration/jira/img/jira_dev_panel_setup_com_4_v13_9.png
+++ /dev/null
Binary files differ
diff --git a/doc/user/analytics/value_streams_dashboard.md b/doc/user/analytics/value_streams_dashboard.md
index 7d1b3f88826..a8c0ad0a7aa 100644
--- a/doc/user/analytics/value_streams_dashboard.md
+++ b/doc/user/analytics/value_streams_dashboard.md
@@ -19,22 +19,6 @@ The Value Streams Dashboard is a customizable dashboard that enables decision-ma
This page is a work in progress, and we're updating the information as we add more features.
For more information, see the [Value Stream Management category direction page](https://about.gitlab.com/direction/plan/value_stream_management/).
-## View the value streams dashboard
-
-Prerequisite:
-
-- To view the value streams dashboard for a group, you must have at least the Reporter role for the group.
-
-To view the value streams dashboard:
-
-1. On the top bar, select **Main menu**, and:
- - For a project, select **Projects** and find your project.
- - For a group, select **Groups** and find your group.
-1. On the left sidebar, select **Analytics > Value stream**.
-1. Below the **Filter results** text box, in the **Key metrics** row, select **Value Streams Dashboard | DORA**.
-1. Optional. To open the new page, append this path `/analytics/dashboards/value_streams_dashboard` to the group URL
-(for example, `https://gitlab.com/groups/gitlab-org/-/analytics/dashboards/value_streams_dashboard`).
-
## Initial use case
Our initial use case is focused on providing the ability to compare software delivery metrics.
@@ -65,6 +49,22 @@ that are the largest value contributors, overperforming, or underperforming.
You can also drill down the metrics for further analysis.
When you hover over a metric, a tooltip displays an explanation of the metric and a link to the related documentation page.
+## View the value streams dashboard
+
+Prerequisite:
+
+- To view the value streams dashboard for a group, you must have at least the Reporter role for the group.
+
+To view the value streams dashboard:
+
+1. On the top bar, select **Main menu**, and:
+ - For a project, select **Projects** and find your project.
+ - For a group, select **Groups** and find your group.
+1. On the left sidebar, select **Analytics > Value stream**.
+1. Below the **Filter results** text box, in the **Key metrics** row, select **Value Streams Dashboard | DORA**.
+1. Optional. To open the new page, append this path `/analytics/dashboards/value_streams_dashboard` to the group URL
+(for example, `https://gitlab.com/groups/gitlab-org/-/analytics/dashboards/value_streams_dashboard`).
+
## Customize the dashboard panels
You can customize the Value Streams Dashboard and configure what subgroups and projects to include in the page.