diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-28 12:10:15 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-10-28 12:10:15 +0300 |
commit | 25788905108838d95a62d7e3ad3ca16e6f6d0fda (patch) | |
tree | 72f4cb84b9ad509d4bda9aa838a751d123082708 /doc | |
parent | 5431dbfffcd7ae1cacc9b68b719b0e8fea29e6a4 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/.vale/gitlab/Admin.yml | 13 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 20 | ||||
-rw-r--r-- | doc/development/ee_features.md | 27 | ||||
-rw-r--r-- | doc/development/service_ping/metrics_instrumentation.md | 6 |
4 files changed, 27 insertions, 39 deletions
diff --git a/doc/.vale/gitlab/Admin.yml b/doc/.vale/gitlab/Admin.yml deleted file mode 100644 index 6160eb85c8e..00000000000 --- a/doc/.vale/gitlab/Admin.yml +++ /dev/null @@ -1,13 +0,0 @@ ---- -# Suggestion: gitlab.Admin -# -# Checks for "admin" and recommends using the full word instead. "Admin Area" is OK. -# -# For a list of all options, see https://vale.sh/docs/topics/styles/ -extends: substitution -message: 'Verify this use of the word "admin". Can it be updated to "administration", "administrator", "administer", or "Admin Area"?' -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html -level: suggestion -ignorecase: false -swap: - '[Aa]dmin ?\w*': '(?:Admin( Area| Mode)?|[Aa]dminist(ration|rator|rators|er|rative|ering|ered))' diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index 46b23e4394e..8fe1ac5c696 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -595,7 +595,7 @@ Returns [`Vulnerability`](#vulnerability). ### `Query.workItem` -Find a work item. Returns `null` if `work_items` feature flag is disabled. +Find a work item. WARNING: **Introduced** in 15.1. @@ -5777,7 +5777,7 @@ Input type: `VulnerabilityRevertToDetectedInput` ### `Mutation.workItemCreate` -Creates a work item. Available only when feature flag `work_items` is enabled. +Creates a work item. WARNING: **Introduced** in 15.1. @@ -5808,7 +5808,7 @@ Input type: `WorkItemCreateInput` ### `Mutation.workItemCreateFromTask` -Creates a work item from a task in another work item's description. Available only when feature flag `work_items` is enabled. +Creates a work item from a task in another work item's description. WARNING: **Introduced** in 15.1. @@ -5835,7 +5835,7 @@ Input type: `WorkItemCreateFromTaskInput` ### `Mutation.workItemDelete` -Deletes a work item. Available only when feature flag `work_items` is enabled. +Deletes a work item. WARNING: **Introduced** in 15.1. @@ -5860,7 +5860,7 @@ Input type: `WorkItemDeleteInput` ### `Mutation.workItemDeleteTask` -Deletes a task in a work item's description. Available only when feature flag `work_items` is enabled. +Deletes a task in a work item's description. WARNING: **Introduced** in 15.1. @@ -5887,7 +5887,7 @@ Input type: `WorkItemDeleteTaskInput` ### `Mutation.workItemUpdate` -Updates a work item by Global ID. Available only when feature flag `work_items` is enabled. +Updates a work item by Global ID. WARNING: **Introduced** in 15.1. @@ -5924,7 +5924,7 @@ Input type: `WorkItemUpdateInput` ### `Mutation.workItemUpdateTask` -Updates a work item's task by Global ID. Available only when feature flag `work_items` is enabled. +Updates a work item's task by Global ID. WARNING: **Introduced** in 15.1. @@ -13585,7 +13585,7 @@ Returns [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount). ##### `Group.workItemTypes` -Work item types available to the group. Returns `null` if `work_items` feature flag is disabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. +Work item types available to the group. Returns [`WorkItemTypeConnection`](#workitemtypeconnection). @@ -17521,7 +17521,7 @@ Returns [`VulnerabilitySeveritiesCount`](#vulnerabilityseveritiescount). ##### `Project.workItemTypes` -Work item types available to the project. Returns `null` if `work_items` feature flag is disabled. This flag is disabled by default, because the feature is experimental and is subject to change without notice. +Work item types available to the project. Returns [`WorkItemTypeConnection`](#workitemtypeconnection). @@ -21052,7 +21052,7 @@ Issue type. | <a id="issuetypeincident"></a>`INCIDENT` | Incident issue type. | | <a id="issuetypeissue"></a>`ISSUE` | Issue issue type. | | <a id="issuetyperequirement"></a>`REQUIREMENT` | Requirement issue type. | -| <a id="issuetypetask"></a>`TASK` **{warning-solid}** | **Introduced** in 15.2. This feature is in Alpha. It can be changed or removed at any time. Task issue type. Available only when feature flag `work_items` is enabled. | +| <a id="issuetypetask"></a>`TASK` **{warning-solid}** | **Introduced** in 15.2. This feature is in Alpha. It can be changed or removed at any time. Task issue type. | | <a id="issuetypetest_case"></a>`TEST_CASE` | Test Case issue type. | ### `IterationSearchableField` diff --git a/doc/development/ee_features.md b/doc/development/ee_features.md index ac740542ef5..9b17b694194 100644 --- a/doc/development/ee_features.md +++ b/doc/development/ee_features.md @@ -120,24 +120,25 @@ To do so: ### Simulate a SaaS instance -If you're developing locally and need your instance to act like the SaaS version of the product, -you can simulate SaaS by exporting an environment variable: +If you're developing locally and need your instance to simulate the SaaS (GitLab.com) +version of the product: -```shell -export GITLAB_SIMULATE_SAAS=1 -``` +1. Export this environment variable: -There are many ways to pass an environment variable to your local GitLab instance. -For example, you can create a `env.runit` file in the root of your GDK with the above snippet. + ```shell + export GITLAB_SIMULATE_SAAS=1 + ``` -#### Enable plans per namespace + There are many ways to pass an environment variable to your local GitLab instance. + For example, you can create an `env.runit` file in the root of your GDK with the above snippet. -To enable plans per namespace turn on the `Allow use of licensed EE features` option from the settings page. -This will make licensed EE features available to projects only if the project namespace's plan includes the feature -or if the project is public. To enable it: +1. Enable **Allow use of licensed EE features** to make licensed EE features available to projects + only if the project namespace's plan includes the feature. -1. If you are developing locally, follow the steps in [Simulate a SaaS instance](#simulate-a-saas-instance) to make the option available. -1. Visit Admin > Settings > General > "Account and limit" and enable "Allow use of licensed EE features". + 1. Visit **Admin > Settings > General**. + 1. Expand **Account and limit**. + 1. Select the **Allow use of licensed EE features** checkbox. + 1. Click **Save changes**. ### Run CI pipelines in a FOSS context diff --git a/doc/development/service_ping/metrics_instrumentation.md b/doc/development/service_ping/metrics_instrumentation.md index 4b00d1fc56d..759e1cf11df 100644 --- a/doc/development/service_ping/metrics_instrumentation.md +++ b/doc/development/service_ping/metrics_instrumentation.md @@ -41,7 +41,7 @@ We have built a domain-specific language (DSL) to define the metrics instrumenta You can use database metrics to track data kept in the database, for example, a count of issues that exist on a given instance. - `operation`: Operations for the given `relation`, one of `count`, `distinct_count`, `sum`, and `average`. -- `relation`: `ActiveRecord::Relation` for the objects we want to perform the `operation`. +- `relation`: Assigns lambda that returns the `ActiveRecord::Relation` for the objects we want to perform the `operation`. The assigned lambda can accept up to one parameter. The parameter is hashed and stored under the `options` key in the metric definition. - `start`: Specifies the start value of the batch counting, by default is `relation.minimum(:id)`. - `finish`: Specifies the end value of the batch counting, by default is `relation.maximum(:id)`. - `cache_start_and_finish_as`: Specifies the cache key for `start` and `finish` values and sets up caching them. Use this call when `start` and `finish` are expensive queries that should be reused between different metric calculations. @@ -55,10 +55,10 @@ module Gitlab module Usage module Metrics module Instrumentations - class CountBoardsMetric < DatabaseMetric + class CountIssuesMetric < DatabaseMetric operation :count - relation { Board } + relation ->(options) { Issue.where(confidential: options[:confidential]) } end end end |