diff --git a/doc/.vale/gitlab/SubstitutionSuggestions.yml b/doc/.vale/gitlab/SubstitutionSuggestions.yml index 21cabf1e0a7c908ed0ca516000bc70ed1673a489..123b4a30625e51f925b7d5118584344da3b9e52c 100644 --- a/doc/.vale/gitlab/SubstitutionSuggestions.yml +++ b/doc/.vale/gitlab/SubstitutionSuggestions.yml @@ -27,3 +27,4 @@ swap: sub-group: "subgroup" sub-groups: "subgroups" within: "in" + ex: "for example" diff --git a/doc/api/commits.md b/doc/api/commits.md index d3481eb77c00560c34254dff09b993b346e3e042..83fa54231ee4cdfc930b63c26829cb2ef27c56e7 100644 --- a/doc/api/commits.md +++ b/doc/api/commits.md @@ -100,15 +100,15 @@ POST /projects/:id/repository/commits | `stats` | boolean | no | Include commit stats. Default is true | | `force` | boolean | no | When `true` overwrites the target branch with a new commit based on the `start_branch` or `start_sha` | -| `actions[]` Attribute | Type | Required | Description | -| --------------------- | ---- | -------- | ----------- | -| `action` | string | yes | The action to perform, `create`, `delete`, `move`, `update`, `chmod`| -| `file_path` | string | yes | Full path to the file. Ex. `lib/class.rb` | -| `previous_path` | string | no | Original full path to the file being moved. Ex. `lib/class1.rb`. Only considered for `move` action. | -| `content` | string | no | File content, required for all except `delete`, `chmod`, and `move`. Move actions that do not specify `content` preserve the existing file content, and any other value of `content` overwrites the file content. | -| `encoding` | string | no | `text` or `base64`. `text` is default. | -| `last_commit_id` | string | no | Last known file commit ID. Only considered in update, move, and delete actions. | -| `execute_filemode` | boolean | no | When `true/false` enables/disables the execute flag on the file. Only considered for `chmod` action. | +| `actions[]` Attribute | Type | Required | Description | +|-----------------------|---------|----------|-------------| +| `action` | string | yes | The action to perform: `create`, `delete`, `move`, `update`, or `chmod`. | +| `file_path` | string | yes | Full path to the file. For example: `lib/class.rb`. | +| `previous_path` | string | no | Original full path to the file being moved. For example `lib/class1.rb`. Only considered for `move` action. | +| `content` | string | no | File content, required for all except `delete`, `chmod`, and `move`. Move actions that do not specify `content` preserve the existing file content, and any other value of `content` overwrites the file content. | +| `encoding` | string | no | `text` or `base64`. `text` is default. | +| `last_commit_id` | string | no | Last known file commit ID. Only considered in update, move, and delete actions. | +| `execute_filemode` | boolean | no | When `true/false` enables/disables the execute flag on the file. Only considered for `chmod` action. | ```shell PAYLOAD=$(cat << 'JSON' diff --git a/doc/api/group_wikis.md b/doc/api/group_wikis.md index cba64269942762d99a66d84d153e3036c1f6b6ef..d5fe7825dc635e85eb6288d7fc0bc34207558945 100644 --- a/doc/api/group_wikis.md +++ b/doc/api/group_wikis.md @@ -131,13 +131,13 @@ Update an existing wiki page. At least one parameter is required to update the w PUT /groups/:id/wikis/:slug ``` -| Attribute | Type | Required | Description | -| --------------- | ------- | --------------------------------- | ------------------------------- | -| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding) | -| `content` | string | yes if `title` is not provided | The content of the wiki page | -| `title` | string | yes if `content` is not provided | The title of the wiki page | -| `format` | string | no | The format of the wiki page. Available formats are: `markdown` (default), `rdoc`, `asciidoc` and `org` | -| `slug` | string | yes | URL encoded slug (a unique string) of the wiki page. Ex. dir%2Fpage_name | +| Attribute | Type | Required | Description | +|-----------|----------------|----------------------------------|-------------| +| `id` | integer/string | yes | The ID or [URL-encoded path of the group](index.md#namespaced-path-encoding). | +| `content` | string | yes if `title` is not provided | The content of the wiki page. | +| `title` | string | yes if `content` is not provided | The title of the wiki page. | +| `format` | string | no | The format of the wiki page. Available formats are `markdown` (default), `rdoc`, `asciidoc`, and `org`. | +| `slug` | string | yes | URL encoded slug (a unique string) of the wiki page. For example: `dir%2Fpage_name`. | ```shell curl --request PUT --data "format=rdoc&content=documentation&title=Docs" \ diff --git a/doc/api/settings.md b/doc/api/settings.md index 76bb6d1e6658f92e301b59a7cb29d4d9994819ac..1ff47c64f0c78cce68e1c89b60d4f8ba0ebdac48 100644 --- a/doc/api/settings.md +++ b/doc/api/settings.md @@ -306,7 +306,7 @@ listed in the descriptions of the relevant settings. | `disabled_oauth_sign_in_sources` | array of strings | no | Disabled OAuth sign-in sources. | | `dns_rebinding_protection_enabled` | boolean | no | Enforce DNS rebinding attack protection. | | `domain_denylist_enabled` | boolean | no | (**If enabled, requires:** `domain_denylist`) Allows blocking sign-ups from emails from specific domains. | -| `domain_denylist` | array of strings | no | Users with email addresses that match these domains **cannot** sign up. Wildcards allowed. Use separate lines for multiple entries. Ex: `domain.com`, `*.domain.com`. | +| `domain_denylist` | array of strings | no | Users with email addresses that match these domains **cannot** sign up. Wildcards allowed. Use separate lines for multiple entries. For example: `domain.com`, `*.domain.com`. | | `domain_allowlist` | array of strings | no | Force people to use only corporate emails for sign-up. Default is `null`, meaning there is no restriction. | | `dsa_key_restriction` | integer | no | The minimum allowed bit length of an uploaded DSA key. Default is `0` (no restriction). `-1` disables DSA keys. | | `ecdsa_key_restriction` | integer | no | The minimum allowed curve size (in bits) of an uploaded ECDSA key. Default is `0` (no restriction). `-1` disables ECDSA keys. | diff --git a/doc/development/elasticsearch.md b/doc/development/elasticsearch.md index ab2d241a781eaaea4aad24a0da50e5353f2dd0ae..8ddc4c21af9c737b60fd319586dcfc7d70046b5d 100644 --- a/doc/development/elasticsearch.md +++ b/doc/development/elasticsearch.md @@ -115,7 +115,7 @@ Patterns: - `"(\\p{Ll}+|\\p{Lu}\\p{Ll}+|\\p{Lu}+)"`: captures CamelCased and lowedCameCased strings as separate tokens - `"(\\d+)"`: extracts digits -- `"(?=([\\p{Lu}]+[\\p{L}]+))"`: captures CamelCased strings recursively. Ex: `ThisIsATest` => `[ThisIsATest, IsATest, ATest, Test]` +- `"(?=([\\p{Lu}]+[\\p{L}]+))"`: captures CamelCased strings recursively. For example: `ThisIsATest` => `[ThisIsATest, IsATest, ATest, Test]` - `'"((?:\\"|[^"]|\\")*)"'`: captures terms inside quotes, removing the quotes - `"'((?:\\'|[^']|\\')*)'"`: same as above, for single-quotes - `'\.([^.]+)(?=\.|\s|\Z)'`: separate terms with periods in-between diff --git a/doc/development/merge_request_performance_guidelines.md b/doc/development/merge_request_performance_guidelines.md index 3b814ee32924b6eb96fac98f48a1646d784153df..76bb2e84a089c043d7f923c2eb3e77893447aa1f 100644 --- a/doc/development/merge_request_performance_guidelines.md +++ b/doc/development/merge_request_performance_guidelines.md @@ -463,7 +463,7 @@ Read more about when and how feature flags should be used in We can consider the following types of storages: -- **Local temporary storage** (very-very short-term storage) This type of storage is system-provided storage, ex. `/tmp` folder. +- **Local temporary storage** (very-very short-term storage) This type of storage is system-provided storage, like a `/tmp` folder. This is the type of storage that you should ideally use for all your temporary tasks. The fact that each node has its own temporary storage makes scaling significantly easier. This storage is also very often SSD-based, thus is significantly faster. @@ -480,7 +480,7 @@ We can consider the following types of storages: Be respectful of that. - **Shared persistent storage** (long-term storage) This type of storage uses - shared network-based storage (ex. NFS). This solution is mostly used by customers running small + shared network-based storage (for example, NFS). This solution is mostly used by customers running small installations consisting of a few nodes. The files on shared storage are easily accessible, but any job that is uploading or downloading data can create a serious contention to all other jobs. This is also an approach by default used by Omnibus. @@ -531,7 +531,7 @@ The move operation on the same destination is instantaneous. The system instead of performing `copy` operation just re-attaches file into a new place. Since this introduces extra complexity into application, you should only try -to re-use well established patterns (ex.: `ObjectStorage` concern) instead of re-implementing it. +to re-use well established patterns (for example, `ObjectStorage` concern) instead of re-implementing it. The usage of shared temporary storage is otherwise deprecated for all other usages. diff --git a/doc/development/testing_guide/end_to_end/feature_flags.md b/doc/development/testing_guide/end_to_end/feature_flags.md index 6d826e170f6b9d0d1c56190f9a15c6459bd826a5..b9a36bfb60c8d523b8dd3d230e541842f51eb439 100644 --- a/doc/development/testing_guide/end_to_end/feature_flags.md +++ b/doc/development/testing_guide/end_to_end/feature_flags.md @@ -42,7 +42,7 @@ or [feature group](../../feature_flags/index.md#feature-groups). with administrator access, such as staging. **Note on `requires_admin`:** This tag should still be applied if there are other actions within the test that require administrator access that are unrelated to updating a -feature flag (ex: creating a user via the API). +feature flag (like creating a user via the API). The code below would enable a feature flag named `:feature_flag_name` for the project created by the test: diff --git a/doc/topics/git/subtree.md b/doc/topics/git/subtree.md index 1d624b453488db0dc5940599e78db4a6f1a8a4b1..a8a665d4e1352b08b799052d7cca2073022775ce 100644 --- a/doc/topics/git/subtree.md +++ b/doc/topics/git/subtree.md @@ -16,9 +16,7 @@ comments: false - Add: `git subtree add --prefix <target-folder> <url> <branch> --squash` - Pull: `git subtree pull --prefix <target-folder> <url> <branch> --squash` -- Push: `git subtree add --prefix <target-folder> <url> <branch>` -- Ex: `git config alias.sbp 'subtree pull --prefix st / - git@gitlab.com:balameb/subtree-nested-example.git master --squash'` +- Push: `git subtree push --prefix <target-folder> <url> <branch>` ```shell # Add an alias diff --git a/doc/user/project/push_options.md b/doc/user/project/push_options.md index b31ef858d5975ff153acf55e37f593ae07d954bc..9e5413b020e90d72692a1116f8840f9d13b2c832 100644 --- a/doc/user/project/push_options.md +++ b/doc/user/project/push_options.md @@ -61,10 +61,10 @@ time as pushing changes: | `merge_request.target=<branch_name>` | Set the target of the merge request to a particular branch or upstream project, such as: `git push -o merge_request.target=project_path/branch` | [11.10](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/26752) | | `merge_request.merge_when_pipeline_succeeds` | Set the merge request to [merge when its pipeline succeeds](merge_requests/merge_when_pipeline_succeeds.md). | [11.10](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/26752) | | `merge_request.remove_source_branch` | Set the merge request to remove the source branch when it's merged. | [12.2](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/64320) | -| `merge_request.title="<title>"` | Set the title of the merge request. Ex: `git push -o merge_request.title="The title I want"`. | [12.2](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/64320) | -| `merge_request.description="<description>"` | Set the description of the merge request. Ex: `git push -o merge_request.description="The description I want"`. | [12.2](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/64320) | -| `merge_request.draft` | Mark the merge request as a draft. Ex: `git push -o merge_request.draft`. | [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/296673) | -| `merge_request.milestone="<milestone>"` | Set the milestone of the merge request. Ex: `git push -o merge_request.milestone="3.0"`. | [14.1](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63960) | +| `merge_request.title="<title>"` | Set the title of the merge request. For example: `git push -o merge_request.title="The title I want"`. | [12.2](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/64320) | +| `merge_request.description="<description>"` | Set the description of the merge request. For example: `git push -o merge_request.description="The description I want"`. | [12.2](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/64320) | +| `merge_request.draft` | Mark the merge request as a draft. For example: `git push -o merge_request.draft`. | [15.0](https://gitlab.com/gitlab-org/gitlab/-/issues/296673) | +| `merge_request.milestone="<milestone>"` | Set the milestone of the merge request. For example: `git push -o merge_request.milestone="3.0"`. | [14.1](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/63960) | | `merge_request.label="<label>"` | Add labels to the merge request. If the label does not exist, it is created. For example, for two labels: `git push -o merge_request.label="label1" -o merge_request.label="label2"`. | [12.3](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31831) | | `merge_request.unlabel="<label>"` | Remove labels from the merge request. For example, for two labels: `git push -o merge_request.unlabel="label1" -o merge_request.unlabel="label2"`. | [12.3](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/31831) | | `merge_request.assign="<user>"` | Assign users to the merge request. Accepts username or user ID. For example, for two users: `git push -o merge_request.assign="user1" -o merge_request.assign="user2"`. | [13.10](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/25904), support for usernames added in [15.5](https://gitlab.com/gitlab-org/gitlab/-/issues/344276) |