From 2bf3744e2bc9690c6258b7cb1b9d4ce95f62a7ff Mon Sep 17 00:00:00 2001 From: Marcel Amirault <mamirault@gitlab.com> Date: Mon, 30 Sep 2024 16:10:47 +0900 Subject: [PATCH] Clean up stray whitespace in gitlab project --- doc/administration/geo/index.md | 2 +- .../geo/replication/troubleshooting/common.md | 2 +- doc/administration/gitaly/recovery.md | 2 +- doc/administration/logs/index.md | 4 ++-- doc/development/advanced_search.md | 6 +++--- .../ai_features/ai_feature_development_playbook.md | 4 ++-- doc/user/gitlab_duo/turn_on_off.md | 2 +- doc/user/project/integrations/webhook_events.md | 2 +- doc/user/project/pages/getting_started_part_one.md | 2 +- doc/user/version.md | 2 +- 10 files changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/administration/geo/index.md b/doc/administration/geo/index.md index da74b20189a2f..5a77a043f70a0 100644 --- a/doc/administration/geo/index.md +++ b/doc/administration/geo/index.md @@ -232,7 +232,7 @@ This list of limitations only reflects the latest version of GitLab. If you are ### Replicated data types -There is a complete list of all GitLab [data types](replication/datatypes.md) and +There is a complete list of all GitLab [data types](replication/datatypes.md) and [replicated data types](replication/datatypes.md#replicated-data-types). ## Setup instructions diff --git a/doc/administration/geo/replication/troubleshooting/common.md b/doc/administration/geo/replication/troubleshooting/common.md index 5a0adb7ebdc88..b1ae380369878 100644 --- a/doc/administration/geo/replication/troubleshooting/common.md +++ b/doc/administration/geo/replication/troubleshooting/common.md @@ -634,7 +634,7 @@ Reason: end of file reached ``` -It might happen if the incorrect URL to the primary site was specified in the setting. To troubleshoot it, +It might happen if the incorrect URL to the primary site was specified in the setting. To troubleshoot it, run the following commands in [the Rails Console](../../../operations/rails_console.md): ```ruby diff --git a/doc/administration/gitaly/recovery.md b/doc/administration/gitaly/recovery.md index d108458ed3783..14b277db62798 100644 --- a/doc/administration/gitaly/recovery.md +++ b/doc/administration/gitaly/recovery.md @@ -58,7 +58,7 @@ is set. ##### Replication factor set If a custom replication factor is set, use [`praefect set-replication-factor`](praefect.md#configure-replication-factor) to set the replication factor per repository again to get -new storage assigned. +new storage assigned. For example, if two nodes in the virtual storage have a replication factor of 2 and a new node (`gitaly-3`) is added, you should increase the replication factor to 3: diff --git a/doc/administration/logs/index.md b/doc/administration/logs/index.md index 8991cf5f24243..ab7ffdda743fa 100644 --- a/doc/administration/logs/index.md +++ b/doc/administration/logs/index.md @@ -1029,7 +1029,7 @@ DETAILS: > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/120506) in GitLab 16.0. The `llm.log` file logs information related to -[AI features](../../user/ai_features.md). Logging includes information about AI events. +[AI features](../../user/ai_features.md). Logging includes information about AI events. ### LLM input and output logging @@ -1046,7 +1046,7 @@ This flag is disabled by default and can only be enabled: - For GitLab.com, when you provide consent through a GitLab [Support Ticket](https://about.gitlab.com/support/portal/). - For self-managed, when you enable this feature flag. -By default, the log does not contain LLM prompt input and response output to support [data retention policies](../../user/gitlab_duo/data_usage.md#data-retention) of AI feature data. +By default, the log does not contain LLM prompt input and response output to support [data retention policies](../../user/gitlab_duo/data_usage.md#data-retention) of AI feature data. The log file is located at: diff --git a/doc/development/advanced_search.md b/doc/development/advanced_search.md index 49311fa22daae..718b65e867f6f 100644 --- a/doc/development/advanced_search.md +++ b/doc/development/advanced_search.md @@ -344,7 +344,7 @@ Also check that the index is able to handle the index request. For example, chec #### Transfers and deletes -Project and group transfers and deletes must make updates to the index to avoid orphaned data. +Project and group transfers and deletes must make updates to the index to avoid orphaned data. Indexes that contain a `project_id` field must use the [`Search::Elastic::DeleteWorker`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/workers/search/elastic/delete_worker.rb). Indexes that contain a `namespace_id` field but no `project_id` field must use [`Search::ElasticGroupAssociationDeleteWorker`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/app/workers/search/elastic_group_association_deletion_worker.rb). @@ -724,7 +724,7 @@ Requires `source_branch` field. Query with `source_branch` or `not_source_branch ##### `by_group_level_authorization` -Requires `current_user`, `group_ids`, `traversal_id`, `search_level` fields. Query with `search_level` and +Requires `current_user`, `group_ids`, `traversal_id`, `search_level` fields. Query with `search_level` and filter on `namespace_visibility_level` based on permissions user has for each group. NOTE: @@ -894,7 +894,7 @@ Requires `project_id` and `traversal_id` fields. Supports feature `*_access_leve Filtering is applied for: -- search level for global, group, or project +- search level for global, group, or project - membership for direct membership to groups and projects or shared membership through direct access to a group - any feature access levels passed through `features` diff --git a/doc/development/ai_features/ai_feature_development_playbook.md b/doc/development/ai_features/ai_feature_development_playbook.md index 8f88fa6e1e07b..c584dee816377 100644 --- a/doc/development/ai_features/ai_feature_development_playbook.md +++ b/doc/development/ai_features/ai_feature_development_playbook.md @@ -199,11 +199,11 @@ Once we have developed our application being able to assure that it behaves as e When first starting out building applications ontop of LLMs we will want to do evaluation. A common first question to ask is how many records should we have in our dataset. This question is a little premature for reasons that should be clear soon. -First things first, before thinking about how much data, lets think about how representative our data needs to be of the problem your app needs to solve and where we can get that. +First things first, before thinking about how much data, lets think about how representative our data needs to be of the problem your app needs to solve and where we can get that. As an example where we are constantly itterating on this at GitLab, let's consider the evaluation of our code completion offering. What we use in practice for evaluation is a dataset made up of functions taken from GitLab codebase that have been split in half. The first half is the prompt (input) the second half is the part we will compare to what the model produces (expected output). -As said we evaluate our code completion application with a dataset that was created from GitLab code, this means a lot of Ruby, Go, Python, and several other languages. Let's remember many of our customers write their code in Java. At this point a worth while question to ask is, would you characterise our dataset as representative? Honestly, in the beginning probably not. There are times where we must accept in the begining that the best we can do is the best we can do, but keeping this in mind and trying to improve the alignment between what we evaluate against and what our application is the best thing to focus on when creating / improving a dataset. As part of this dataset creation / improvment effort we also want to keep a diverse spread of types of prompts. Following our code +As said we evaluate our code completion application with a dataset that was created from GitLab code, this means a lot of Ruby, Go, Python, and several other languages. Let's remember many of our customers write their code in Java. At this point a worth while question to ask is, would you characterise our dataset as representative? Honestly, in the beginning probably not. There are times where we must accept in the begining that the best we can do is the best we can do, but keeping this in mind and trying to improve the alignment between what we evaluate against and what our application is the best thing to focus on when creating / improving a dataset. As part of this dataset creation / improvment effort we also want to keep a diverse spread of types of prompts. Following our code completion example, as mentioned before we probalby want to have more Java prompts but we don't just want leet-code style interview questions. We also want examples that would be in enterprise backend applications, android applcations, gradle plugins, yes even some basic interview questions, and any more diverse places where Java would be used. Now that we have thought about having representative data, let's think about how many datapoints we need. In evaluation we are trying to make an assesment of how well our application is doing. If you could imagine flipping a coin that may be unfair, flipping it 10 times wouldn't give you a lot of confidence but flipping it 10,000 times probably would. That said similarly to how flipping a coin 10,000 times would take a while to do, running 10,000 prompts would take longer than running about a 100 or so. In the early stages of development we would want to balance iteration speed and accuracy, and to that end we recommend 70 to 120 prompts, but if you can add more without comprimising your iteration time this is strongly encouraged. As you move toward an internal beta and definately as you diff --git a/doc/user/gitlab_duo/turn_on_off.md b/doc/user/gitlab_duo/turn_on_off.md index a8f1a3e8386a3..8276fa4184f27 100644 --- a/doc/user/gitlab_duo/turn_on_off.md +++ b/doc/user/gitlab_duo/turn_on_off.md @@ -90,7 +90,7 @@ To run a health check: ### Health check tests -The health check performs the following tests to verify if your instance meets the requirements to use GitLab Duo. +The health check performs the following tests to verify if your instance meets the requirements to use GitLab Duo. | Test | Description | |-----------------|-------------| diff --git a/doc/user/project/integrations/webhook_events.md b/doc/user/project/integrations/webhook_events.md index fa405c0666970..cc2bc8fb5ca75 100644 --- a/doc/user/project/integrations/webhook_events.md +++ b/doc/user/project/integrations/webhook_events.md @@ -2155,7 +2155,7 @@ Payload example: > - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/141907) in GitLab 16.10 [with a flag](../../../administration/feature_flags.md) named `access_token_webhooks`. Disabled by default. > - [Enabled on GitLab.com](https://gitlab.com/gitlab-org/gitlab/-/issues/439379) in GitLab 16.11. > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/issues/454642) in GitLab 16.11. Feature flag `access_token_webhooks` removed. -> - `full_path` attribute [added](https://gitlab.com/gitlab-org/gitlab/-/issues/465421) in GitLab 17.4. +> - `full_path` attribute [added](https://gitlab.com/gitlab-org/gitlab/-/issues/465421) in GitLab 17.4. Two access token expiration events are generated: diff --git a/doc/user/project/pages/getting_started_part_one.md b/doc/user/project/pages/getting_started_part_one.md index b2ad298f9adf3..b3e23f8f90411 100644 --- a/doc/user/project/pages/getting_started_part_one.md +++ b/doc/user/project/pages/getting_started_part_one.md @@ -40,7 +40,7 @@ Pages domains are `*.gitlab.io`. | Project pages owned by a subgroup | `acmecorp/documentation/product-manual` | `http(s)://acmecorp.example.io/documentation/product-manual`| When the **Use unique domain** setting is enabled, Pages builds a unique domain name from -the flattened project name and a six-character unique ID. Users receive a `308 Permanent Redirect` status +the flattened project name and a six-character unique ID. Users receive a `308 Permanent Redirect` status redirecting the browser to these unique domain URLs. Browsers might cache this redirect: | Type of GitLab Pages | Example path of a project in GitLab | Website URL | diff --git a/doc/user/version.md b/doc/user/version.md index 1f04f811417eb..a98ed6373ec93 100644 --- a/doc/user/version.md +++ b/doc/user/version.md @@ -15,7 +15,7 @@ Prerequisites: - You must be an authenticated user. -To find the version for self-managed GitLab: +To find the version for self-managed GitLab: - On the left sidebar, at the bottom, select **Help > Help**. -- GitLab