diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/.vale/gitlab/CurrentStatus.yml | 5 | ||||
-rw-r--r-- | doc/.vale/gitlab/ElementDescriptors.yml | 17 | ||||
-rw-r--r-- | doc/.vale/gitlab/InclusionAbleism.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/InclusionGender.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/Simplicity.yml | 4 | ||||
-rw-r--r-- | doc/.vale/gitlab/Units.yml | 4 | ||||
-rw-r--r-- | doc/administration/housekeeping.md | 23 | ||||
-rw-r--r-- | doc/api/appearance.md | 3 | ||||
-rw-r--r-- | doc/api/graphql/reference/index.md | 3 | ||||
-rw-r--r-- | doc/api/merge_request_approvals.md | 8 | ||||
-rw-r--r-- | doc/subscriptions/gitlab_com/index.md | 15 | ||||
-rw-r--r-- | doc/user/admin_area/settings/account_and_limit_settings.md | 2 | ||||
-rw-r--r-- | doc/user/project/merge_requests/img/add_previously_merged_commits_button_v14_1.png | bin | 19306 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/merge_requests/img/commit_nav_v13_11.png | bin | 24164 -> 0 bytes | |||
-rw-r--r-- | doc/user/project/merge_requests/img/previously_merged_commits_v14_1.png | bin | 26788 -> 0 bytes |
15 files changed, 65 insertions, 27 deletions
diff --git a/doc/.vale/gitlab/CurrentStatus.yml b/doc/.vale/gitlab/CurrentStatus.yml index 57b95dcf4ac..9972573b406 100644 --- a/doc/.vale/gitlab/CurrentStatus.yml +++ b/doc/.vale/gitlab/CurrentStatus.yml @@ -1,14 +1,13 @@ --- -# Suggestion: gitlab.CurrentStatus +# Warning: gitlab.CurrentStatus # # Checks for words that indicate a product or feature may change in the future. # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Remove '%s'. The documentation reflects the current state of the product." -level: suggestion +level: warning ignorecase: true link: https://docs.gitlab.com/ee/development/documentation/versions.html#promising-features-in-future-versions tokens: - currently - - yet diff --git a/doc/.vale/gitlab/ElementDescriptors.yml b/doc/.vale/gitlab/ElementDescriptors.yml index f3573f5ce65..f806f5878e1 100644 --- a/doc/.vale/gitlab/ElementDescriptors.yml +++ b/doc/.vale/gitlab/ElementDescriptors.yml @@ -1,13 +1,14 @@ --- -# Suggestion: gitlab.ElementDescriptors +# Warning: gitlab.ElementDescriptors # -# Suggests the correct way to describe elements in a form. +# Suggests the correct way to describe a button. # # For a list of all options, see https://vale.sh/docs/topics/styles/ -extends: substitution -message: "When describing elements, %s '%s'." -link: https://docs.gitlab.com/ee/development/documentation/styleguide/index.html#language -level: suggestion +extends: existence +message: "If possible, rewrite to remove 'button'." +link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html#button +level: warning ignorecase: true -swap: - button: 'if possible, rewrite to remove' +scope: raw +raw: + - \*\*.+?\*\* button diff --git a/doc/.vale/gitlab/InclusionAbleism.yml b/doc/.vale/gitlab/InclusionAbleism.yml index 7419430c8a2..3ee356155cd 100644 --- a/doc/.vale/gitlab/InclusionAbleism.yml +++ b/doc/.vale/gitlab/InclusionAbleism.yml @@ -1,5 +1,5 @@ --- -# Suggestion: gitlab.InclusionAbleism +# Warning: gitlab.InclusionAbleism # # Suggests alternatives for words that foster ableism. # @@ -7,7 +7,7 @@ extends: substitution message: "Use inclusive language. Consider '%s' instead of '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html -level: suggestion +level: warning ignorecase: true swap: sanity (?:check|test): check for completeness diff --git a/doc/.vale/gitlab/InclusionGender.yml b/doc/.vale/gitlab/InclusionGender.yml index ce8861b6a09..dcf8c1930ec 100644 --- a/doc/.vale/gitlab/InclusionGender.yml +++ b/doc/.vale/gitlab/InclusionGender.yml @@ -1,5 +1,5 @@ --- -# Suggestion: gitlab.InclusionGender +# Warning: gitlab.InclusionGender # # Suggests alternatives for words that are gender-specific. # @@ -7,7 +7,7 @@ extends: substitution message: "Use inclusive language. Consider '%s' instead of '%s'." link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html -level: suggestion +level: warning ignorecase: true swap: mankind: humanity, people diff --git a/doc/.vale/gitlab/Simplicity.yml b/doc/.vale/gitlab/Simplicity.yml index 89169c1aa46..fd9b1c5e5a6 100644 --- a/doc/.vale/gitlab/Simplicity.yml +++ b/doc/.vale/gitlab/Simplicity.yml @@ -1,12 +1,12 @@ --- -# Suggestion: gitlab.Simplicity +# Warning: gitlab.Simplicity # # Checks for words implying ease of use, to avoid cognitive dissonance for frustrated users. # # For a list of all options, see https://vale.sh/docs/topics/styles/ extends: existence message: "Remove '%s'. Be precise instead of subjective." -level: suggestion +level: warning ignorecase: true link: https://docs.gitlab.com/ee/development/documentation/styleguide/word_list.html tokens: diff --git a/doc/.vale/gitlab/Units.yml b/doc/.vale/gitlab/Units.yml index 4211fdee38b..e6263ad66b4 100644 --- a/doc/.vale/gitlab/Units.yml +++ b/doc/.vale/gitlab/Units.yml @@ -1,5 +1,5 @@ --- -# Suggestion: gitlab.Units +# Warning: gitlab.Units # # Recommends a space between a number and a unit of measure. # @@ -8,7 +8,7 @@ extends: existence message: "Add a space between the number and the unit in '%s'." link: 'https://docs.gitlab.com/ee/development/documentation/styleguide/' nonword: true -level: suggestion +level: warning ignorecase: true tokens: - \d+(?:B|kB|KiB|MB|MiB|GB|GiB|TB|TiB) diff --git a/doc/administration/housekeeping.md b/doc/administration/housekeeping.md index 814575caf50..584f06ef537 100644 --- a/doc/administration/housekeeping.md +++ b/doc/administration/housekeeping.md @@ -45,11 +45,12 @@ be slow. ### Heuristical housekeeping -> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2634) in GitLab 14.9 for the [manual trigger](#manual-trigger) and the [push-based trigger](#push-based-trigger) [with a flag](feature_flags.md) named `optimized_housekeeping`. Disabled by default. +> - [Introduced](https://gitlab.com/gitlab-org/gitaly/-/issues/2634) in GitLab 14.9 for the [manual trigger](#manual-trigger) and the [push-based trigger](#push-based-trigger) [with a flag](feature_flags.md) named `optimized_housekeeping`. Enabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/353607) in GitLab 14.10. FLAG: -On self-managed GitLab, by default this feature is not available for the [manual trigger](#manual-trigger) and the [push-based trigger](#push-based-trigger). +On self-managed GitLab, by default this feature is available. To hide the feature, ask an administrator to [disable the feature flag](feature_flags.md) named `optimize_repository`. + To make it available, ask an administrator to [enable the feature flag](feature_flags.md) named `optimized_housekeeping`. The heuristical (or "opportunistic") housekeeping strategy analyzes the @@ -79,6 +80,19 @@ more time the bigger they get. It is especially important in large monorepos (which receive a lot of traffic) to avoid optimizing them too frequently. +You can change how often Gitaly is asked to optimize a repository. + +1. On the top bar, select **Main menu > Admin**. +1. On the left sidebar, select **Settings > Repository**. +1. Expand **Repository maintenance**. +1. In the **Housekeeping** section, configure the housekeeping options. +1. Select **Save changes**. + +- **Enable automatic repository housekeeping**: Regularly ask Gitaly to run repository optimization. If you + keep this setting disabled for a long time, Git repository access on your GitLab server becomes + slower and your repositories use more disk space. +- **Optimize repository period**: Number of Git pushes after which Gitaly is asked to optimize a repository. + ## Running housekeeping tasks There are different ways in which GitLab runs housekeeping tasks: @@ -108,8 +122,13 @@ To trigger housekeeping tasks manually: This starts an asynchronous background worker for the project's repository. The background worker executes `git gc`, which performs a number of optimizations. +<!--- start_remove The following content will be removed on remove_date: '2023-04-22' --> + ### Push-based trigger +FLAG: +On self-managed GitLab, by default this feature is not available and superseded by [heuristical housekeeping](#heuristical-housekeeping). It is planned to be removed in 15.8. To enable the feature, ask an administrator to [disable the feature flag](feature_flags.md) named `optimize_repository`. + GitLab automatically runs repository housekeeping tasks after a configured number of pushes: diff --git a/doc/api/appearance.md b/doc/api/appearance.md index f8926f8a91d..622239e7283 100644 --- a/doc/api/appearance.md +++ b/doc/api/appearance.md @@ -29,6 +29,7 @@ Example response: ```json { "title": "GitLab Test Instance", + "short_title": "GitLab", "description": "gitlab-test.example.com", "logo": "/uploads/-/system/appearance/logo/1/logo.png", "header_logo": "/uploads/-/system/appearance/header_logo/1/header.png", @@ -54,6 +55,7 @@ PUT /application/appearance | Attribute | Type | Required | Description | | --------------------------------- | ------- | -------- | ----------- | | `title` | string | no | Instance title on the sign in / sign up page +| `short_title` | string | no | Short title for progressive web app | `description` | string | no | Markdown text shown on the sign in / sign up page | `logo` | mixed | no | Instance image used on the sign in / sign up page. See [Change logo](#change-logo) | `header_logo` | mixed | no | Instance image used for the main navigation bar @@ -75,6 +77,7 @@ Example response: ```json { "title": "GitLab Test Instance", + "short_title": "GitLab", "description": "gitlab-test.example.com", "logo": "/uploads/-/system/appearance/logo/1/logo.png", "header_logo": "/uploads/-/system/appearance/header_logo/1/header.png", diff --git a/doc/api/graphql/reference/index.md b/doc/api/graphql/reference/index.md index bc7b151a9be..a3d4458bb6c 100644 --- a/doc/api/graphql/reference/index.md +++ b/doc/api/graphql/reference/index.md @@ -17020,10 +17020,11 @@ Represents vulnerability finding of a security report on the pipeline. | <a id="pipelinesecurityreportfindingreporttype"></a>`reportType` | [`VulnerabilityReportType`](#vulnerabilityreporttype) | Type of the security report that found the vulnerability finding. | | <a id="pipelinesecurityreportfindingscanner"></a>`scanner` | [`VulnerabilityScanner`](#vulnerabilityscanner) | Scanner metadata for the vulnerability. | | <a id="pipelinesecurityreportfindingseverity"></a>`severity` | [`VulnerabilitySeverity`](#vulnerabilityseverity) | Severity of the vulnerability finding. | -| <a id="pipelinesecurityreportfindingsolution"></a>`solution` | [`String`](#string) | URL to the vulnerability's details page. | +| <a id="pipelinesecurityreportfindingsolution"></a>`solution` | [`String`](#string) | Solution for resolving the security report finding. | | <a id="pipelinesecurityreportfindingstate"></a>`state` | [`VulnerabilityState`](#vulnerabilitystate) | Finding status. | | <a id="pipelinesecurityreportfindingtitle"></a>`title` | [`String`](#string) | Title of the vulnerability finding. | | <a id="pipelinesecurityreportfindinguuid"></a>`uuid` | [`String`](#string) | UUIDv5 digest based on the vulnerability's report type, primary identifier, location, fingerprint, project identifier. | +| <a id="pipelinesecurityreportfindingvulnerability"></a>`vulnerability` | [`Vulnerability`](#vulnerability) | Vulnerability related to the security report finding. | ### `PreviewBillableUserChange` diff --git a/doc/api/merge_request_approvals.md b/doc/api/merge_request_approvals.md index bc91f2752c6..d9777b87ff2 100644 --- a/doc/api/merge_request_approvals.md +++ b/doc/api/merge_request_approvals.md @@ -85,6 +85,7 @@ Supported attributes: > - Pagination support [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/31011) in GitLab 15.3 [with a flag](../administration/feature_flags.md) named `approval_rules_pagination`. Enabled by default. > - `applies_to_all_protected_branches` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335316) in GitLab 15.3. > - Pagination support [generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/366823) in GitLab 15.7. Feature flag `approval_rules_pagination` removed. +> - `usernames` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/) in GitLab 15.8. You can request information about a project's approval rules using the following endpoint: @@ -188,6 +189,7 @@ Supported attributes: > - Introduced in GitLab 13.7. > - `applies_to_all_protected_branches` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335316) in GitLab 15.3. +> - `usernames` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/) in GitLab 1x.x. You can request information about a single project approval rules using the following endpoint: @@ -289,6 +291,7 @@ Supported attributes: > - Moved to GitLab Premium in 13.9. > - [Removed](https://gitlab.com/gitlab-org/gitlab/-/issues/357300) the Vulnerability-Check feature in GitLab 15.0. > - `applies_to_all_protected_branches` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335316) in GitLab 15.3. +> - `usernames` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/) in GitLab 1x.x. You can create project approval rules using the following endpoint: @@ -309,6 +312,7 @@ Supported attributes: | `report_type` | string | **{dotted-circle}** No | The report type required when the rule type is `report_approver`. The supported report types are `license_scanning` and `code_coverage`. | | `rule_type` | string | **{dotted-circle}** No | The type of rule. `any_approver` is a pre-configured default rule with `approvals_required` at `0`. Other rules are `regular`. | | `user_ids` | Array | **{dotted-circle}** No | The IDs of users as approvers. | +| `usernames` | string array | **{dotted-circle}** No | The usernames for this rule. | ```json { @@ -414,6 +418,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \ > - Moved to GitLab Premium in 13.9. > - [Removed](https://gitlab.com/gitlab-org/gitlab/-/issues/357300) the Vulnerability-Check feature in GitLab 15.0. > - `applies_to_all_protected_branches` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/335316) in GitLab 15.3. +> - `usernames` property was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/) in GitLab 1x.x. You can update project approval rules using the following endpoint: @@ -436,6 +441,7 @@ Supported attributes: | `protected_branch_ids` | Array | **{dotted-circle}** No | The IDs of protected branches to scope the rule by. To identify the ID, [use the API](protected_branches.md#list-protected-branches). | | `remove_hidden_groups` | boolean | **{dotted-circle}** No | Whether hidden groups should be removed. | | `user_ids` | Array | **{dotted-circle}** No | The IDs of users as approvers. | +| `usernames` | string array | **{dotted-circle}** No | The usernames for this rule. | ```json { @@ -879,6 +885,7 @@ Supported attributes: | `approval_project_rule_id` | integer | **{dotted-circle}** No | The ID of a project-level approval rule. | | `group_ids` | Array | **{dotted-circle}** No | The IDs of groups as approvers. | | `user_ids` | Array | **{dotted-circle}** No | The IDs of users as approvers. | +| `usernames` | string array | **{dotted-circle}** No | The usernames for this rule. | **Important:** When `approval_project_rule_id` is set, the `name`, `users` and `groups` of project-level rule are copied. The `approvals_required` specified @@ -969,6 +976,7 @@ Supported attributes: | `group_ids` | Array | **{dotted-circle}** No | The IDs of groups as approvers. | | `remove_hidden_groups` | boolean | **{dotted-circle}** No | Whether hidden groups should be removed. | | `user_ids` | Array | **{dotted-circle}** No | The IDs of users as approvers. | +| `usernames` | string array | **{dotted-circle}** No | The usernames for this rule. | ```json { diff --git a/doc/subscriptions/gitlab_com/index.md b/doc/subscriptions/gitlab_com/index.md index 75fbd5b7b55..552e9c46c4a 100644 --- a/doc/subscriptions/gitlab_com/index.md +++ b/doc/subscriptions/gitlab_com/index.md @@ -323,10 +323,17 @@ For details on upgrading your subscription tier, see ### Automatic subscription renewal -When you enable automatic renewal, the subscription automatically renews on the -expiration date without a gap in available service. An invoice is -generated for the renewal and available for viewing or download on the -[View invoices](https://customers.gitlab.com/receipts) page. +When a subscription is set to auto-renew, it renews automatically on the +expiration date without a gap in available service. Subscriptions purchased through Customers Portal or GitLab.com are set to auto-renew by default. The number of seats is adjusted to fit the [number of billable users in your group](#view-seat-usage) at the time of renewal. You can view and download your renewal invoice on the +[View invoices](https://customers.gitlab.com/receipts) page. If your account has a [saved credit card](../index.md#change-your-payment-method), the card is charged for the invoice amount. If we are unable to process a payment or the auto-renewal fails for any other reason, you have 14 days to renew your subscription. After that, your access is downgraded. + +#### Email notifications + +15 days before a subscription automatically renews, an email is sent with information about the renewal. + +- If your credit card is expired, the email tells you how to update it. +- If you have any outstanding overages, the email tells you to contact our Sales team. +- If there are no issues, the email specifies the names and quantity of the products being renewed. The email also includes the total amount you owe. If your usage increases or decreases before renewal, this amount can change. #### Enable or disable automatic subscription renewal diff --git a/doc/user/admin_area/settings/account_and_limit_settings.md b/doc/user/admin_area/settings/account_and_limit_settings.md index 44a6bbb9d8e..b235b812416 100644 --- a/doc/user/admin_area/settings/account_and_limit_settings.md +++ b/doc/user/admin_area/settings/account_and_limit_settings.md @@ -57,7 +57,7 @@ You can change the maximum push size for your instance: 1. On the left sidebar, select **Settings > General**, then expand **Account and limit**. 1. Increase or decrease by changing the value in **Maximum push size (MB)**. -For GitLab.com application limits, read [GitLab application limits](../../../administration/instance_limits.md#max-push-size). +For GitLab.com push size limits, read [accounts and limit settings](../../gitlab_com/index.md#account-and-limit-settings). NOTE: When you [add files to a repository](../../project/repository/web_editor.md#create-a-file) diff --git a/doc/user/project/merge_requests/img/add_previously_merged_commits_button_v14_1.png b/doc/user/project/merge_requests/img/add_previously_merged_commits_button_v14_1.png Binary files differdeleted file mode 100644 index e60e869f854..00000000000 --- a/doc/user/project/merge_requests/img/add_previously_merged_commits_button_v14_1.png +++ /dev/null diff --git a/doc/user/project/merge_requests/img/commit_nav_v13_11.png b/doc/user/project/merge_requests/img/commit_nav_v13_11.png Binary files differdeleted file mode 100644 index a9bc8fa6bee..00000000000 --- a/doc/user/project/merge_requests/img/commit_nav_v13_11.png +++ /dev/null diff --git a/doc/user/project/merge_requests/img/previously_merged_commits_v14_1.png b/doc/user/project/merge_requests/img/previously_merged_commits_v14_1.png Binary files differdeleted file mode 100644 index 4f49fad10ad..00000000000 --- a/doc/user/project/merge_requests/img/previously_merged_commits_v14_1.png +++ /dev/null |