From d3c6af02488df401beeaacfb215f4a981bef569a Mon Sep 17 00:00:00 2001 From: Lysanne Pinto <lpinto@gitlab.com> Date: Fri, 19 Apr 2024 21:35:33 +0000 Subject: [PATCH] April: fix trailing whitespace in GitLab project --- doc/administration/geo/setup/two_single_node_sites.md | 2 +- doc/administration/reference_architectures/10k_users.md | 2 +- doc/administration/reference_architectures/1k_users.md | 2 +- doc/administration/reference_architectures/25k_users.md | 2 +- doc/administration/reference_architectures/2k_users.md | 2 +- doc/administration/reference_architectures/3k_users.md | 2 +- doc/administration/reference_architectures/5k_users.md | 2 +- doc/architecture/blueprints/ai_gateway/index.md | 8 ++++---- .../blueprints/cells/infrastructure/postgresql.md | 4 ++-- doc/architecture/blueprints/organization/index.md | 2 +- doc/ci/jobs/job_rules.md | 2 +- doc/ci/steps/index.md | 4 ++-- doc/development/ai_features/index.md | 6 +++--- .../merge_request_concepts/mergeability_framework.md | 2 +- doc/subscriptions/subscription-add-ons.md | 2 +- doc/update/versions/gitlab_16_changes.md | 4 ++-- doc/user/analytics/value_streams_dashboard.md | 4 ++-- doc/user/application_security/container_scanning/index.md | 2 +- doc/user/application_security/sast/index.md | 2 +- .../repository/code_suggestions/supported_extensions.md | 2 +- 20 files changed, 29 insertions(+), 29 deletions(-) diff --git a/doc/administration/geo/setup/two_single_node_sites.md b/doc/administration/geo/setup/two_single_node_sites.md index a1e8c3b5e1146..f6c6a89377b5d 100644 --- a/doc/administration/geo/setup/two_single_node_sites.md +++ b/doc/administration/geo/setup/two_single_node_sites.md @@ -62,7 +62,7 @@ Prerequisites: This command uses the `external_url` defined in `/etc/gitlab/gitlab.rb`. 1. Create a password for the `gitlab` database user and update Rail to use the new password. - + NOTE: The values configured for the `gitlab_rails['db_password']` and `postgresql['sql_user_password']` settings need to match. However, only the `postgresql['sql_user_password']` value should be the MD5 encrypted password. diff --git a/doc/administration/reference_architectures/10k_users.md b/doc/administration/reference_architectures/10k_users.md index d112c6174bf57..f29caf62a40dd 100644 --- a/doc/administration/reference_architectures/10k_users.md +++ b/doc/administration/reference_architectures/10k_users.md @@ -4,7 +4,7 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: 200 RPS or up to 10,000 users +# Reference architecture: 200 RPS or up to 10,000 users DETAILS: **Tier:** Premium, Ultimate diff --git a/doc/administration/reference_architectures/1k_users.md b/doc/administration/reference_architectures/1k_users.md index af32496658364..9e93a05d3556a 100644 --- a/doc/administration/reference_architectures/1k_users.md +++ b/doc/administration/reference_architectures/1k_users.md @@ -4,7 +4,7 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: 20 RPS or up to 1,000 users +# Reference architecture: 20 RPS or up to 1,000 users DETAILS: **Tier:** Free, Premium, Ultimate diff --git a/doc/administration/reference_architectures/25k_users.md b/doc/administration/reference_architectures/25k_users.md index d43ab226e00b1..316d874ae921f 100644 --- a/doc/administration/reference_architectures/25k_users.md +++ b/doc/administration/reference_architectures/25k_users.md @@ -4,7 +4,7 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: 500 RPS or up to 25,000 users +# Reference architecture: 500 RPS or up to 25,000 users DETAILS: **Tier:** Premium, Ultimate diff --git a/doc/administration/reference_architectures/2k_users.md b/doc/administration/reference_architectures/2k_users.md index c08972a9c7a11..c8d9dbcf02578 100644 --- a/doc/administration/reference_architectures/2k_users.md +++ b/doc/administration/reference_architectures/2k_users.md @@ -4,7 +4,7 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: 40 RPS or up to 2,000 users +# Reference architecture: 40 RPS or up to 2,000 users DETAILS: **Tier:** Free, Premium, Ultimate diff --git a/doc/administration/reference_architectures/3k_users.md b/doc/administration/reference_architectures/3k_users.md index 7b7b1469fd335..f7de7fd745bf6 100644 --- a/doc/administration/reference_architectures/3k_users.md +++ b/doc/administration/reference_architectures/3k_users.md @@ -4,7 +4,7 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: 60 RPS or up to 3,000 users +# Reference architecture: 60 RPS or up to 3,000 users DETAILS: **Tier:** Premium, Ultimate diff --git a/doc/administration/reference_architectures/5k_users.md b/doc/administration/reference_architectures/5k_users.md index 56f114949dd77..71bc40cd9ae3e 100644 --- a/doc/administration/reference_architectures/5k_users.md +++ b/doc/administration/reference_architectures/5k_users.md @@ -4,7 +4,7 @@ group: Distribution info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments --- -# Reference architecture: 100 RPS or up to 5,000 users +# Reference architecture: 100 RPS or up to 5,000 users DETAILS: **Tier:** Premium, Ultimate diff --git a/doc/architecture/blueprints/ai_gateway/index.md b/doc/architecture/blueprints/ai_gateway/index.md index 3af9139100dfe..14f937c166b74 100644 --- a/doc/architecture/blueprints/ai_gateway/index.md +++ b/doc/architecture/blueprints/ai_gateway/index.md @@ -568,7 +568,7 @@ AI Gateway aim is to become the primary method for the monolith to **access** ma ### Centralized Access Through AI Gateway -The AI Gateway, a standalone service, is the sole access point for all communication between GitLab installations and third-party AI models. It is designed to centralize and manage access to all GitLab features, whether they are in-app functionalities or code suggestions, irrespective of their deployment methods. +The AI Gateway, a standalone service, is the sole access point for all communication between GitLab installations and third-party AI models. It is designed to centralize and manage access to all GitLab features, whether they are in-app functionalities or code suggestions, irrespective of their deployment methods. This strategy significantly simplifies enterprise management and abstracts machine learning away from the monolith. With future expansions including telemetry, embeddings API, and multi-region/customer-specific deployments, our goal is to provide a scalable, comprehensive AI solution for all GitLab users, regardless of their installation type. @@ -580,9 +580,9 @@ This strategy significantly simplifies enterprise management and abstracts machi Unit Primitives are a fundamental part of our strategy for managing access to AI features through the AI Gateway. They represent the smallest unit of functionality that can be accessed and managed through the Gateway. This approach provides a more granular control over the functionalities exposed through the AI Gateway and simplifies the management of AI features. It also paves the way for future work on supporting user-deployed models and locally hosted models. From a business perspective, unit primitives are the smallest pieces that may be shuffled across various tiers or packaging models, providing flexibility and adaptability in our offerings. -In the initial iteration, we will support two primitives: Code Suggestions and Chat. The latter will encompass all Chat features in one primitive. +In the initial iteration, we will support two primitives: Code Suggestions and Chat. The latter will encompass all Chat features in one primitive. -In the next iteration, we plan to decompose the Chat primitive into multiple primitives based on top-level tools. This work is dependent on the completion of the task to move classification into the AI Gateway. +In the next iteration, we plan to decompose the Chat primitive into multiple primitives based on top-level tools. This work is dependent on the completion of the task to move classification into the AI Gateway. The introduction of Unit Primitives will simplify the management of AI features and provide a more granular control over the functionalities exposed through the AI Gateway. This will also pave the way for future work on supporting user-deployed models and locally hosted models. @@ -609,7 +609,7 @@ While AI Gateway centralizes _access_ to AI features and models, it interacts wi ### AI Agents -[AI Agents](https://gitlab.com/groups/gitlab-org/-/epics/12330) is a feature that allows users to implement and manage their own chats and AI features, managing prompts, models and tools. Development is currently in its early stages. Once mature, we intend to move GitLab feature to agents, but there are blockers that currently prevent us from doing so: +[AI Agents](https://gitlab.com/groups/gitlab-org/-/epics/12330) is a feature that allows users to implement and manage their own chats and AI features, managing prompts, models and tools. Development is currently in its early stages. Once mature, we intend to move GitLab feature to agents, but there are blockers that currently prevent us from doing so: - [Lack of prompt templating](https://gitlab.com/gitlab-org/gitlab/-/issues/441081). - Implement replication of user-defined prompts into ai-gateway. diff --git a/doc/architecture/blueprints/cells/infrastructure/postgresql.md b/doc/architecture/blueprints/cells/infrastructure/postgresql.md index ccda1d1156bef..78539b219b0c1 100644 --- a/doc/architecture/blueprints/cells/infrastructure/postgresql.md +++ b/doc/architecture/blueprints/cells/infrastructure/postgresql.md @@ -207,11 +207,11 @@ Most of the information above can be found in the official [Cloud SQL documentat #### Things to validate -- Could we use the offered [logical replication feature](https://cloud.google.com/sql/docs/postgres/replication/configure-external-replica) ([pglogical](https://github.com/2ndQuadrant/pglogical)) for our migration needs? - estimate 2-4 weeks +- Could we use the offered [logical replication feature](https://cloud.google.com/sql/docs/postgres/replication/configure-external-replica) ([pglogical](https://github.com/2ndQuadrant/pglogical)) for our migration needs? - estimate 2-4 weeks - Can we access WAL and base_backups, as it appears in the [pitr documentation](https://cloud.google.com/sql/docs/postgres/backup-recovery/pitr#log-storage-for-pitr), in contrast to our meeting, where GCP denied it. - estimate < 1 week - How long does a major upgrade take for our 50k reference architecture? - estimate 4-5 weeks - Is [Query Insights](https://cloud.google.com/sql/docs/postgres/using-query-insights) a sufficient replacement for the current observability tooling. -- How long does it take to create a read-replica? How long does it take to create a new cluster from backup? `10GB`, `100GB`, `1TB` - estimate 1 week +- How long does it take to create a read-replica? How long does it take to create a new cluster from backup? `10GB`, `100GB`, `1TB` - estimate 1 week ### k8s Operator diff --git a/doc/architecture/blueprints/organization/index.md b/doc/architecture/blueprints/organization/index.md index 5f78b51879c97..cb20f27875bdd 100644 --- a/doc/architecture/blueprints/organization/index.md +++ b/doc/architecture/blueprints/organization/index.md @@ -190,7 +190,7 @@ For a deeper exploration of the impact on select features, see the [list of feat ### Alignment between Organization and Fulfillment -Fulfillment enhancements for Organizations will happen in a different timeline to the [Cells](../cells/index.md) project and should not be seen as blockers to any Cells timelines. +Fulfillment enhancements for Organizations will happen in a different timeline to the [Cells](../cells/index.md) project and should not be seen as blockers to any Cells timelines. For Cells 1.0, Billing remains at the top-level Group. Said otherwise, Billing will not occur at the Organization level. The guidance for Cells 1.0 is for GitLab.com SaaS customers to use a single top-level Group to keep Billing consolidated. diff --git a/doc/ci/jobs/job_rules.md b/doc/ci/jobs/job_rules.md index cc086085be3a0..3b8e482fc22f8 100644 --- a/doc/ci/jobs/job_rules.md +++ b/doc/ci/jobs/job_rules.md @@ -93,7 +93,7 @@ runs in branch and tag pipelines. ### Skip jobs if the branch is empty -Use [`rules:changes:compare_to`](../yaml/index.md#ruleschangescompare_to) to +Use [`rules:changes:compare_to`](../yaml/index.md#ruleschangescompare_to) to skip a job when the branch is empty, which saves CI/CD resources. The configuration compares the branch to the default branch, and if the branch: diff --git a/doc/ci/steps/index.md b/doc/ci/steps/index.md index 588d7abbbca8b..9b6061fa58275 100644 --- a/doc/ci/steps/index.md +++ b/doc/ci/steps/index.md @@ -127,7 +127,7 @@ Remote step references are the URL of a Git repo, the character `@`, and the tag Step runner looks for a file `step.yml` at the root of the repository. Local steps begin with `.` and point to a directory where step-runner looks for `step.yml`. -Local references always use the path separator `/` regardless of operating system. +Local references always use the path separator `/` regardless of operating system. The OS appropriate separate is used when loading the file. ```yaml @@ -142,7 +142,7 @@ my-job: step: ./my-local-steps/uname ``` -To use steps in a job, provide steps in a variable and invoke the step runner the job `script` keyword. Support to use steps in a job as a `run` keyword in a GitLab CI pipeline configuration is proposed in [epic 11525](https://gitlab.com/groups/gitlab-org/-/epics/11525). +To use steps in a job, provide steps in a variable and invoke the step runner the job `script` keyword. Support to use steps in a job as a `run` keyword in a GitLab CI pipeline configuration is proposed in [epic 11525](https://gitlab.com/groups/gitlab-org/-/epics/11525). ```yaml # Example work-around until run keyword is implemented diff --git a/doc/development/ai_features/index.md b/doc/development/ai_features/index.md index b63270abb827e..5c66cc888b9a8 100644 --- a/doc/development/ai_features/index.md +++ b/doc/development/ai_features/index.md @@ -10,7 +10,7 @@ info: Any user with at least the Maintainer role can merge updates to this conte ## Get started -### Access +### Access #### GCP Vertex @@ -502,7 +502,7 @@ TODO ## Embeddings database -Embeddings are required to be generated for chat documentation tool to work. Documentation tool works on Saas only at this point. +Embeddings are required to be generated for chat documentation tool to work. Documentation tool works on Saas only at this point. Embeddings are generated through the [VertexAI text embeddings API](https://cloud.google.com/vertex-ai/generative-ai/docs/embeddings/get-text-embeddings). @@ -579,7 +579,7 @@ context 'when asking about how to use GitLab', :ai_embedding_fixtures do end ``` -## Monitoring +## Monitoring - Error ratio and response latency apdex for each Ai action can be found on [Sidekiq Service dashboard](https://dashboards.gitlab.net/d/sidekiq-main/sidekiq-overview?orgId=1) under **SLI Detail: `llm_completion`**. - Spent tokens, usage of each Ai feature and other statistics can be found on [periscope dashboard](https://app.periscopedata.com/app/gitlab/1137231/Ai-Features). diff --git a/doc/development/merge_request_concepts/mergeability_framework.md b/doc/development/merge_request_concepts/mergeability_framework.md index ffd9e64422e8a..1ad540b0c3e55 100644 --- a/doc/development/merge_request_concepts/mergeability_framework.md +++ b/doc/development/merge_request_concepts/mergeability_framework.md @@ -91,7 +91,7 @@ The mergeability checks live under `app/services/merge_requests/mergeability/`. ## Merge when checks pass -When we want to add the check to the Merge When Checks Pass feature, we must: +When we want to add the check to the Merge When Checks Pass feature, we must: 1. Allow the check to be skipped in the class. 1. Add the parameter to the list in the method `skipped_mergeable_checks`. diff --git a/doc/subscriptions/subscription-add-ons.md b/doc/subscriptions/subscription-add-ons.md index dbcbcd72e983b..44a80e9977005 100644 --- a/doc/subscriptions/subscription-add-ons.md +++ b/doc/subscriptions/subscription-add-ons.md @@ -153,7 +153,7 @@ Prerequisites: - To find your subscription name: 1. In the Customers Portal, on the **Subscriptions & purchases** page, find the subscription you want to apply the trial to. - 1. At the top of the page, the subscription name appears in a badge. + 1. At the top of the page, the subscription name appears in a badge.  - Ensure the email you submit for trial registration matches the email of the [subscription contact](customers_portal.md#change-your-subscription-contact). diff --git a/doc/update/versions/gitlab_16_changes.md b/doc/update/versions/gitlab_16_changes.md index d9bb9415fc46c..da00a0c3017ba 100644 --- a/doc/update/versions/gitlab_16_changes.md +++ b/doc/update/versions/gitlab_16_changes.md @@ -132,7 +132,7 @@ To workaround the problem: ``` 1. Remove the column. Using `gitlab-psql` or connecting to the database manually, run: - + ```sql ALTER TABLE namespace_settings DROP COLUMN delayed_project_removal; ``` @@ -164,7 +164,7 @@ planned for release in 16.9.1. ### Geo installations -- Due to a [bug in container replication](https://gitlab.com/gitlab-org/gitlab/-/issues/431944), a misconfigured secondary could mark a failed container replication as successful. Subsequent verification would mark the container as failed due to a checksum mismatch. The workaround is to fix the secondary configuration. +- Due to a [bug in container replication](https://gitlab.com/gitlab-org/gitlab/-/issues/431944), a misconfigured secondary could mark a failed container replication as successful. Subsequent verification would mark the container as failed due to a checksum mismatch. The workaround is to fix the secondary configuration. **Affected releases**: | Affected minor releases | Affected patch releases | Fixed in | diff --git a/doc/user/analytics/value_streams_dashboard.md b/doc/user/analytics/value_streams_dashboard.md index 06d62e8402c62..223fc292ec3cb 100644 --- a/doc/user/analytics/value_streams_dashboard.md +++ b/doc/user/analytics/value_streams_dashboard.md @@ -41,7 +41,7 @@ If you upgrade to the Ultimate tier, you get access to historical data, and can The Value Streams Dashboard panels have a default configuration, but you can also [customize the dashboard panels](#customize-the-dashboard-panels). The Value Streams Dashboard includes four panels: -- Overview +- Overview - DevSecOps metrics comparison - DORA Performers score - AI Impact analytics @@ -185,7 +185,7 @@ Prerequisites: - You must have at least the Reporter role for the group. - Overview background aggregation for Value Streams Dashboards must be enabled. - To view AI Impact analytics, you must: - - Enable [Code Suggestions](../../user/project/repository/code_suggestions/index.md). + - Enable [Code Suggestions](../../user/project/repository/code_suggestions/index.md). - Configure [ClickHouse for contribution analytics](../../user/group/contribution_analytics/index.md#contribution-analytics-with-clickhouse). To view the value streams dashboard: diff --git a/doc/user/application_security/container_scanning/index.md b/doc/user/application_security/container_scanning/index.md index 5d29b176c1ca9..6809cfbcfff36 100644 --- a/doc/user/application_security/container_scanning/index.md +++ b/doc/user/application_security/container_scanning/index.md @@ -42,7 +42,7 @@ GitLab integrates with open-source tools for vulnerability static analysis in co WARNING: Support for Grype was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/439164) in GitLab -16.9 and is planned for removal in 17.0. Use Trivy instead. +16.9 and is planned for removal in 17.0. Use Trivy instead. In GitLab 17.0 and later, the Grype analyzer will no longer be maintained, except for limited fixes as explained in our [statement of support](https://about.gitlab.com/support/statement-of-support/#version-support). The existing current major version for the Grype analyzer image will continue to be updated with the latest advisory database, and operating system packages until GitLab 19.0, at which point the analyzer will stop working. diff --git a/doc/user/application_security/sast/index.md b/doc/user/application_security/sast/index.md index 481fe891e9b6f..644245bc31cc9 100644 --- a/doc/user/application_security/sast/index.md +++ b/doc/user/application_security/sast/index.md @@ -662,7 +662,7 @@ removed, or promoted to regular features at any time. Experimental features available are: -- Enable scanning of iOS and Android apps using the [MobSF analyzer](https://gitlab.com/gitlab-org/security-products/analyzers/mobsf/). This includes the automatic detection and scanning of Xcode projects, Android manifest files, `.ipa` (iOS) and `.apk` (Android) binary files. +- Enable scanning of iOS and Android apps using the [MobSF analyzer](https://gitlab.com/gitlab-org/security-products/analyzers/mobsf/). This includes the automatic detection and scanning of Xcode projects, Android manifest files, `.ipa` (iOS) and `.apk` (Android) binary files. These features were previously experimental, but are now generally available: diff --git a/doc/user/project/repository/code_suggestions/supported_extensions.md b/doc/user/project/repository/code_suggestions/supported_extensions.md index 3bca4ec1f7275..34e8c8f10ffc0 100644 --- a/doc/user/project/repository/code_suggestions/supported_extensions.md +++ b/doc/user/project/repository/code_suggestions/supported_extensions.md @@ -25,7 +25,7 @@ To use Code Suggestions, use one of these editor extensions: | JetBrains IDEs | [GitLab Duo Plugin for JetBrains](https://plugins.jetbrains.com/plugin/22325-gitlab-duo) | | Neovim | [`gitlab.vim` plugin](https://gitlab.com/gitlab-org/editor-extensions/gitlab.vim) | -A [GitLab Language Server](https://gitlab.com/gitlab-org/editor-extensions/gitlab-lsp) is used in VS Code, Visual Studio, and Neovim. The Language Server supports faster iteration across more platforms. You can also configure it to support Code Suggestions in IDEs where GitLab doesn't provide official support. +A [GitLab Language Server](https://gitlab.com/gitlab-org/editor-extensions/gitlab-lsp) is used in VS Code, Visual Studio, and Neovim. The Language Server supports faster iteration across more platforms. You can also configure it to support Code Suggestions in IDEs where GitLab doesn't provide official support. You can express interest in other IDE extension support [in this issue](https://gitlab.com/gitlab-org/editor-extensions/meta/-/issues/78). -- GitLab