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-05-09 18:17:20 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-05-09 18:17:20 +0300
commit3670ddd229b178c0a2e09a1466ddfd7fd2f7855d (patch)
tree9be2a8155e0b14fb9a07b6a1c8bcfa629af4a25c /doc
parent0b4adad74b76b34855e9a6d943f9b9188c3914fa (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r--doc/api/graphql/reference/index.md59
-rw-r--r--doc/development/documentation/index.md14
-rw-r--r--doc/development/service_ping/metrics_lifecycle.md56
-rw-r--r--doc/user/markdown.md12
4 files changed, 89 insertions, 52 deletions
diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md
index d37ee757c6b..d6187ea13ea 100644
--- a/doc/api/graphql/reference/index.md
+++ b/doc/api/graphql/reference/index.md
@@ -13184,7 +13184,7 @@ A software dependency used by a project.
| <a id="dependencyid"></a>`id` | [`GlobalID!`](#globalid) | ID of the dependency. |
| <a id="dependencylocation"></a>`location` | [`Location`](#location) | Information about where the dependency is located. |
| <a id="dependencyname"></a>`name` | [`String!`](#string) | Name of the dependency. |
-| <a id="dependencypackager"></a>`packager` | [`String`](#string) | Description of the tool used to manage the dependency. |
+| <a id="dependencypackager"></a>`packager` | [`PackageManager`](#packagemanager) | Description of the tool used to manage the dependency. |
| <a id="dependencyversion"></a>`version` | [`String`](#string) | Version of the dependency. |
### `DependencyProxyBlob`
@@ -15820,6 +15820,24 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric).
| <a id="groupvaluestreamanalyticsflowmetricsissuecountprojectids"></a>`projectIds` | [`[ID!]`](#id) | Project IDs within the group hierarchy. |
| <a id="groupvaluestreamanalyticsflowmetricsissuecountto"></a>`to` | [`Time!`](#time) | Before the date. |
+##### `GroupValueStreamAnalyticsFlowMetrics.issuesCompletedCount`
+
+Number of open issues closed (completed) in the given period. Maximum value is 10,001.
+
+Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric).
+
+###### Arguments
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| <a id="groupvaluestreamanalyticsflowmetricsissuescompletedcountassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. |
+| <a id="groupvaluestreamanalyticsflowmetricsissuescompletedcountauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. |
+| <a id="groupvaluestreamanalyticsflowmetricsissuescompletedcountfrom"></a>`from` | [`Time!`](#time) | After the date. |
+| <a id="groupvaluestreamanalyticsflowmetricsissuescompletedcountlabelnames"></a>`labelNames` | [`[String!]`](#string) | Labels applied to the issue. |
+| <a id="groupvaluestreamanalyticsflowmetricsissuescompletedcountmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Milestone applied to the issue. |
+| <a id="groupvaluestreamanalyticsflowmetricsissuescompletedcountprojectids"></a>`projectIds` | [`[ID!]`](#id) | Project IDs within the group hierarchy. |
+| <a id="groupvaluestreamanalyticsflowmetricsissuescompletedcountto"></a>`to` | [`Time!`](#time) | Before the date. |
+
##### `GroupValueStreamAnalyticsFlowMetrics.leadTime`
Median time from when the issue was created to when it was closed.
@@ -19229,6 +19247,7 @@ four standard [pagination arguments](#connection-pagination-arguments):
| Name | Type | Description |
| ---- | ---- | ----------- |
+| <a id="projectdependenciespackagemanagers"></a>`packageManagers` | [`[PackageManager!]`](#packagemanager) | Filter dependencies by package managers. |
| <a id="projectdependenciessort"></a>`sort` | [`DependencySort`](#dependencysort) | Sort dependencies by given criteria. |
##### `Project.deployment`
@@ -20460,6 +20479,23 @@ Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric).
| <a id="projectvaluestreamanalyticsflowmetricsissuecountmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Milestone applied to the issue. |
| <a id="projectvaluestreamanalyticsflowmetricsissuecountto"></a>`to` | [`Time!`](#time) | Before the date. |
+##### `ProjectValueStreamAnalyticsFlowMetrics.issuesCompletedCount`
+
+Number of open issues closed (completed) in the given period. Maximum value is 10,001.
+
+Returns [`ValueStreamAnalyticsMetric`](#valuestreamanalyticsmetric).
+
+###### Arguments
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| <a id="projectvaluestreamanalyticsflowmetricsissuescompletedcountassigneeusernames"></a>`assigneeUsernames` | [`[String!]`](#string) | Usernames of users assigned to the issue. |
+| <a id="projectvaluestreamanalyticsflowmetricsissuescompletedcountauthorusername"></a>`authorUsername` | [`String`](#string) | Username of the author of the issue. |
+| <a id="projectvaluestreamanalyticsflowmetricsissuescompletedcountfrom"></a>`from` | [`Time!`](#time) | After the date. |
+| <a id="projectvaluestreamanalyticsflowmetricsissuescompletedcountlabelnames"></a>`labelNames` | [`[String!]`](#string) | Labels applied to the issue. |
+| <a id="projectvaluestreamanalyticsflowmetricsissuescompletedcountmilestonetitle"></a>`milestoneTitle` | [`String`](#string) | Milestone applied to the issue. |
+| <a id="projectvaluestreamanalyticsflowmetricsissuescompletedcountto"></a>`to` | [`Time!`](#time) | Before the date. |
+
##### `ProjectValueStreamAnalyticsFlowMetrics.leadTime`
Median time from when the issue was created to when it was closed.
@@ -24747,6 +24783,27 @@ Values for sorting group packages.
| <a id="packagegroupsortversion_asc"></a>`VERSION_ASC` | Ordered by version in ascending order. |
| <a id="packagegroupsortversion_desc"></a>`VERSION_DESC` | Ordered by version in descending order. |
+### `PackageManager`
+
+Values for package manager.
+
+| Value | Description |
+| ----- | ----------- |
+| <a id="packagemanagerbundler"></a>`BUNDLER` | Package manager: bundler. |
+| <a id="packagemanagercomposer"></a>`COMPOSER` | Package manager: composer. |
+| <a id="packagemanagerconan"></a>`CONAN` | Package manager: conan. |
+| <a id="packagemanagergo"></a>`GO` | Package manager: go. |
+| <a id="packagemanagergradle"></a>`GRADLE` | Package manager: gradle. |
+| <a id="packagemanagermaven"></a>`MAVEN` | Package manager: maven. |
+| <a id="packagemanagernpm"></a>`NPM` | Package manager: npm. |
+| <a id="packagemanagernuget"></a>`NUGET` | Package manager: nuget. |
+| <a id="packagemanagerpip"></a>`PIP` | Package manager: pip. |
+| <a id="packagemanagerpipenv"></a>`PIPENV` | Package manager: pipenv. |
+| <a id="packagemanagerpnpm"></a>`PNPM` | Package manager: pnpm. |
+| <a id="packagemanagersbt"></a>`SBT` | Package manager: sbt. |
+| <a id="packagemanagersetuptools"></a>`SETUPTOOLS` | Package manager: setuptools. |
+| <a id="packagemanageryarn"></a>`YARN` | Package manager: yarn. |
+
### `PackageSort`
Values for sorting package.
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md
index c9f31b36e3f..18d962451e4 100644
--- a/doc/development/documentation/index.md
+++ b/doc/development/documentation/index.md
@@ -151,6 +151,20 @@ change, you must update the `CODEOWNERS` file:
1. Add and commit all your changes and push your branch up to `origin`.
1. Create a merge request and assign it to a technical writing manager for review.
+When updating the `codeowners.rake` file:
+
+- To specify multiple writers for a single group, use a space between writer names:
+
+ ```plaintext
+ CodeOwnerRule.new('Group Name', '@writer1 @writer2'),
+ ```
+
+- For a group that does not have an assigned writer, include the group name in the file and comment out the line:
+
+ ```plaintext
+ # CodeOwnerRule.new('Group Name', ''),
+ ```
+
## Move, rename, or delete a page
See [redirects](redirects.md).
diff --git a/doc/development/service_ping/metrics_lifecycle.md b/doc/development/service_ping/metrics_lifecycle.md
index 3c51eefc4b4..318db6895fb 100644
--- a/doc/development/service_ping/metrics_lifecycle.md
+++ b/doc/development/service_ping/metrics_lifecycle.md
@@ -14,57 +14,21 @@ Follow the [Implement Service Ping](implement.md) guide.
## Change an existing metric
-See [this video tutorial](https://youtu.be/bYf3c01KCls) for help with the update of metric attributes.
-
-NOTE:
-The `key_path` attribute represents the location of the metric in Service Ping payload and must not be changed.
-
-Because we do not control when customers update their self-managed instances of GitLab,
-we **STRONGLY DISCOURAGE** changes to the logic used to calculate any metric.
-Any such changes lead to inconsistent reports from multiple GitLab instances.
-If there is a problem with an existing metric, it's best to deprecate the existing metric,
-and use it, side by side, with the desired new metric.
-
-If you do need to change a metric, please notify the Customer Success Ops team (`@csops-team`), Analytics Engineers (`@gitlab-data/analytics-engineers`), and Product Analysts (`@gitlab-data/product-analysts`) teams by `@` mentioning those groups in a comment on the MR.
-Many Service Ping metrics are relied upon for health score and XMAU reporting and
-unexpected changes to those metrics could break reporting.
-
-Example:
-Consider following change. Before GitLab 12.6, the `example_metric` was implemented as:
-
-```ruby
-{
- ...
- example_metric: distinct_count(Project, :creator_id)
-}
-```
-
-For GitLab 12.6, the metric was changed to filter out archived projects:
-
-```ruby
-{
- ...
- example_metric: distinct_count(Project.non_archived, :creator_id)
-}
-```
+WARNING:
+We want to **PREVENT** changes to the calculation logic or important attributes on any metric as this invalidates comparisons of the same metric across different versions of GitLab.
-In this scenario, all instances running up to GitLab 12.5 continue to report `example_metric`,
-including all archived projects, while all instances running GitLab 12.6 and higher filters
-out such projects. As Service Ping data is collected from all reporting instances, the
-resulting dataset includes mixed data, which distorts any following business analysis.
+If you change a metric, you have to consider that not all instances of GitLab are running on the newest version. Old instances will still report the old version of the metric.
+Additionally, a metric's reported numbers are primarily interesting compared to previously reported numbers.
+As a result, if you need to change one of the following parts of a metric, you need to add a new metric instead. It's your choice whether to keep the old metric alongside the new one or [remove it](#remove-a-metric).
-The correct approach is to add a new metric for GitLab 12.6 release with updated logic:
+- **calculation logic**: This means any changes that can produce a different value than the previous implementation
+- **YAML attributes**: The following attributes are directly used for analysis or calculation: `key_path`, `time_frame`, `value_type`, `data_source`.
-```ruby
-{
- ...
- example_metric_without_archived: distinct_count(Project.non_archived, :creator_id)
-}
-```
+If you change the `performance_indicator_type` attribute of a metric or think your case needs an exception from the outlined rules then please notify the Customer Success Ops team (`@csops-team`), Analytics Engineers (`@gitlab-data/analytics-engineers`), and Product Analysts (`@gitlab-data/product-analysts`) teams by `@` mentioning those groups in a comment on the merge request or issue.
-and update existing business analysis artefacts to use `example_metric_without_archived` instead of `example_metric`
+You can change any other attributes without impact to the calculation or analysis. See [this video tutorial](https://youtu.be/bYf3c01KCls) for help updating metric attributes.
-Currently, the [Metrics Dictionary](https://metrics.gitlab.com/) is built automatically once a day. When a change to a metric is made in a YAML file, you can see the change in the dictionary within 24 hours.
+Currently, the [Metrics Dictionary](https://metrics.gitlab.com/) is built automatically once a day. You can see the change in the dictionary within 24 hours when you change the metric's YAML file.
## Remove a metric
diff --git a/doc/user/markdown.md b/doc/user/markdown.md
index ec1ed05af93..104c633229a 100644
--- a/doc/user/markdown.md
+++ b/doc/user/markdown.md
@@ -669,19 +669,21 @@ In addition to this, links to some objects are also recognized and formatted. So
### Show the issue, merge request, or epic title in the reference
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15694) in GitLab 14.6.
+> - Support for issues, merge requests, and epics [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15694) in GitLab 14.6.
+> - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0.
-To include the title in the rendered link of an issue, merge request, or epic, add a plus (`+`)
+To include the title in the rendered link of an issue, work item, merge request, or epic, add a plus (`+`)
at the end of the reference. For example, a reference like `#123+` is rendered as
`The issue title (#123)`.
URL references like `https://gitlab.com/gitlab-org/gitlab/-/issues/1234+` are also expanded.
-### Show the issue or merge request summary in the reference
+### Show the issue, work item or merge request summary in the reference
-> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386937) in GitLab 15.10.
+> - Support for issues and merge requests [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/386937) in GitLab 15.10.
+> - Support for work items [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/390854) in GitLab 16.0.
-To include an extended summary in the rendered link of an issue or merge request, add a `+s`
+To include an extended summary in the rendered link of an issue, work item, or merge request, add a `+s`
at the end of the reference. Summary includes information about **assignees**, **milestone**
and **health status** of referenced item.