diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-02-14 03:10:09 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-02-14 03:10:09 +0300 |
commit | 8aea332821a78e83ce93f5b3bac7de5f95a3c7b8 (patch) | |
tree | 722cb345de067f3b62bbe0f849178c74dec657eb /doc/development | |
parent | 4f4b85e1c7f7a5518f12a6981709cf3ef3f0f653 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
18 files changed, 30 insertions, 34 deletions
diff --git a/doc/development/api_graphql_styleguide.md b/doc/development/api_graphql_styleguide.md index 0b47a7be7f2..94abbda9671 100644 --- a/doc/development/api_graphql_styleguide.md +++ b/doc/development/api_graphql_styleguide.md @@ -1907,7 +1907,7 @@ code so that we have a single source of truth and we do not trigger a subscripti ## Pagination implementation -To learn more, visit [GraphQL pagination](graphql_guide/pagination.md). +For more information, see [GraphQL pagination](graphql_guide/pagination.md). ## Validating arguments diff --git a/doc/development/application_slis/rails_request_apdex.md b/doc/development/application_slis/rails_request_apdex.md index 19a9c67eb8e..dc9d67b0a2b 100644 --- a/doc/development/application_slis/rails_request_apdex.md +++ b/doc/development/application_slis/rails_request_apdex.md @@ -247,7 +247,7 @@ request rates on the In the **Budget Attribution** row, the **Puma Apdex** log link shows you how many requests are not meeting a 1s or 5s target. -Learn more about the content of the dashboard in the documentation for +For more information about the content of the dashboard, see [Dashboards for stage groups](../stage_group_observability/index.md). For more information -on our exploration of the error budget itself, read the infrastructure issue -[Stage group error budget exploration dashboard](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/1365). +about our exploration of the error budget itself, see +[issue 1365](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/1365). diff --git a/doc/development/architecture.md b/doc/development/architecture.md index 984ac49c514..96b70e2fbd8 100644 --- a/doc/development/architecture.md +++ b/doc/development/architecture.md @@ -18,7 +18,7 @@ GitLab is available under [different subscriptions](https://about.gitlab.com/pri New versions of GitLab are released from stable branches, and the `main` branch is used for bleeding-edge development. -For more information, visit the [GitLab Release Process](https://about.gitlab.com/handbook/engineering/releases/). +For more information, see the [GitLab release process](https://about.gitlab.com/handbook/engineering/releases/). Both distributions require additional components. These components are described in the [Component details](#components) section, and all have their own repositories. @@ -771,7 +771,8 @@ Whenever a client requests to pull or push an image from the registry, it returns a `401` response along with a header detailing where to get an authentication token, in this case the GitLab instance. The client then requests a pull or push auth token from GitLab and retries the original request -to the registry. Learn more about [token authentication](https://docs.docker.com/registry/spec/auth/token/). +to the registry. For more information, see +[token authentication](https://docs.docker.com/registry/spec/auth/token/). An external registry can also be configured to use GitLab as an auth endpoint. diff --git a/doc/development/cached_queries.md b/doc/development/cached_queries.md index c8fa3c40f4a..0525603893f 100644 --- a/doc/development/cached_queries.md +++ b/doc/development/cached_queries.md @@ -65,8 +65,8 @@ to view the list of database queries, including cached queries. The performance bar shows a warning when the number of total executed and cached queries is greater than 100. -To learn more about the statistics available to you, read the -[Performance Bar documentation](../administration/monitoring/performance/performance_bar.md). +For more information about the statistics available to you, see +[Performance bar](../administration/monitoring/performance/performance_bar.md). ## What to look for diff --git a/doc/development/contributing/index.md b/doc/development/contributing/index.md index b3d79bec9be..55827e00e43 100644 --- a/doc/development/contributing/index.md +++ b/doc/development/contributing/index.md @@ -26,7 +26,7 @@ Throughout this guide you will see references to CE and EE for abbreviation. ## Code of conduct We want to create a welcoming environment for everyone who is interested in contributing. -Visit our [Code of Conduct page](https://about.gitlab.com/community/contribute/code-of-conduct/) to learn more about our commitment to an open and welcoming environment. +For more information about our commitment to an open and welcoming environment, see our [Code of Conduct page](https://about.gitlab.com/community/contribute/code-of-conduct/). Issues and merge requests should be in English and contain appropriate language for audiences of all ages. diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index 680cc06d792..be5f8c217b7 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -228,7 +228,7 @@ To reach the definition of done, the merge request must create no regressions an - Verified as working in production on GitLab.com. - Verified as working for self-managed instances. -- Verified as supporting [Geo](../../administration/geo/index.md) via the [self-service framework](../geo/framework.md). To learn more see [here](../geo/framework.md#geo-is-a-requirement-in-the-definition-of-done). +- Verified as supporting [Geo](../../administration/geo/index.md) through the [self-service framework](../geo/framework.md). For more information, see [Geo is a requirement in the definition of done](../geo/framework.md#geo-is-a-requirement-in-the-definition-of-done). If a regression occurs, we prefer you revert the change. Your contribution is *incomplete* until you have made sure it meets all of these diff --git a/doc/development/database/migrations_for_multiple_databases.md b/doc/development/database/migrations_for_multiple_databases.md index bc0ef654336..b903c56651d 100644 --- a/doc/development/database/migrations_for_multiple_databases.md +++ b/doc/development/database/migrations_for_multiple_databases.md @@ -10,8 +10,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w This document describes how to properly write database migrations for [the decomposed GitLab application using multiple databases](https://gitlab.com/groups/gitlab-org/-/epics/6168). - -Learn more about general multiple databases support in a [separate document](multiple_databases.md). +For more information, see [Multiple databases](multiple_databases.md). The design for multiple databases (except for the Geo database) assumes that all decomposed databases have **the same structure** (for example, schema), but **the data is different** in each database. This means that some tables do not contain data on each database. diff --git a/doc/development/fe_guide/design_anti_patterns.md b/doc/development/fe_guide/design_anti_patterns.md index 21f257ca4b6..f087fbd8235 100644 --- a/doc/development/fe_guide/design_anti_patterns.md +++ b/doc/development/fe_guide/design_anti_patterns.md @@ -67,9 +67,7 @@ side-effects can be notoriously difficult to reason with. ### References -To read more on this topic, check out the following references: - -- [GlobalVariablesAreBad from C2 wiki](https://wiki.c2.com/?GlobalVariablesAreBad) +For more information, see [Global Variables Are Bad on the C2 wiki](https://wiki.c2.com/?GlobalVariablesAreBad). ## Singleton (Anti-pattern) diff --git a/doc/development/fe_guide/view_component.md b/doc/development/fe_guide/view_component.md index f9d148d8b82..0245110ec75 100644 --- a/doc/development/fe_guide/view_component.md +++ b/doc/development/fe_guide/view_component.md @@ -10,8 +10,8 @@ ViewComponent is a framework for creating reusable, testable & encapsulated view components with Ruby on Rails, without the need for a JavaScript framework like Vue. They are rendered server-side and can be seamlessly used with template languages like [Haml](haml.md). -Refer to the official [documentation](https://viewcomponent.org/) to learn more or -watch this [introduction video](https://youtu.be/akRhUbvtnmo). +For more information, see the [official documentation](https://viewcomponent.org/) or +[this introduction video](https://youtu.be/akRhUbvtnmo). ## Browse components with Lookbook diff --git a/doc/development/performance.md b/doc/development/performance.md index 02e6c2fd884..346f70e04b0 100644 --- a/doc/development/performance.md +++ b/doc/development/performance.md @@ -583,8 +583,8 @@ You may find the results: **Metrics Reports** [dropdown list](../ci/testing/metrics_reports.md). - In the `memory-on-boot` artifacts for a full report and a dependency breakdown. -`derailed_benchmarks` also provides other methods to investigate memory. To learn more, -refer to the [gem documentation](https://github.com/zombocom/derailed_benchmarks#running-derailed-exec). +`derailed_benchmarks` also provides other methods to investigate memory. For more information, see +the [gem documentation](https://github.com/zombocom/derailed_benchmarks#running-derailed-exec). Most of the methods (`derailed exec perf:*`) attempt to boot your Rails app in a `production` environment and run benchmarks against it. It is possible both in GDK and GCK: diff --git a/doc/development/ruby3_gotchas.md b/doc/development/ruby3_gotchas.md index 4768d6e1182..0d000bc68df 100644 --- a/doc/development/ruby3_gotchas.md +++ b/doc/development/ruby3_gotchas.md @@ -57,7 +57,7 @@ To write code that works under both 2.7 and 3.0, consider the following options: We recommend always passing the block explicitly, and prefer two required arguments as block parameters. -To learn more, see [Ruby issue 12706](https://bugs.ruby-lang.org/issues/12706). +For more information, see [Ruby issue 12706](https://bugs.ruby-lang.org/issues/12706). ## `Symbol#to_proc` returns signature metadata consistent with lambdas @@ -92,7 +92,7 @@ called without a receiver. Ruby 3 corrects this: the code that tests `Proc` object arity or parameter lists might now break and has to be updated. -To learn more, see [Ruby issue 16260](https://bugs.ruby-lang.org/issues/16260). +For more information, see [Ruby issue 16260](https://bugs.ruby-lang.org/issues/16260). ## `OpenStruct` does not evaluate fields lazily diff --git a/doc/development/secure_coding_guidelines.md b/doc/development/secure_coding_guidelines.md index 876def53b2d..6c64e3b2acc 100644 --- a/doc/development/secure_coding_guidelines.md +++ b/doc/development/secure_coding_guidelines.md @@ -266,8 +266,7 @@ value, we **will not** be protected against DNS rebinding. This is the case with validators such as the `AddressableUrlValidator` (called with `validates :url, addressable_url: {opts}` or `public_url: {opts}`). Validation errors are only raised when validations are called, for example when a record is created or saved. If we ignore the value returned by the validation -when persisting the record, **we need to recheck** its validity before using it. You can learn more about [Time of Check to Time of Use bugs](#time-of-check-to-time-of-use-bugs) in a later section -of these guidelines. +when persisting the record, **we need to recheck** its validity before using it. For more information, see [Time of check to time of use bugs](#time-of-check-to-time-of-use-bugs). #### Feature-specific mitigations @@ -291,7 +290,7 @@ implement. - For HTTP connections: Disable redirects or validate the redirect destination - To mitigate DNS rebinding attacks, validate and use the first IP address received. -See [`url_blocker_spec.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/spec/lib/gitlab/url_blocker_spec.rb) for examples of SSRF payloads. See [time of check to time of use bugs](#time-of-check-to-time-of-use-bugs) to learn more about DNS rebinding's class of bug. +See [`url_blocker_spec.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/spec/lib/gitlab/url_blocker_spec.rb) for examples of SSRF payloads. For more information about the DNS-rebinding class of bugs, see [Time of check to time of use bugs](#time-of-check-to-time-of-use-bugs). Don't rely on methods like `.start_with?` when validating a URL, or make assumptions about which part of a string maps to which part of a URL. Use the `URI` class to parse the string, and validate diff --git a/doc/development/sidekiq/index.md b/doc/development/sidekiq/index.md index ea6f613a1f2..355f5a3b753 100644 --- a/doc/development/sidekiq/index.md +++ b/doc/development/sidekiq/index.md @@ -131,8 +131,8 @@ gitlab:sidekiq:all_queues_yml:generate` to regenerate `app/workers/all_queues.yml` or `ee/app/workers/all_queues.yml` so that it can be picked up by [`sidekiq-cluster`](../../administration/sidekiq/extra_sidekiq_processes.md) -in installations that don't use routing rules. To learn more about potential changes, -read [Use routing rules by default and deprecate queue selectors for self-managed](https://gitlab.com/groups/gitlab-com/gl-infra/-/epics/596). +in installations that don't use routing rules. For more information about potential changes, +see [epic 596](https://gitlab.com/groups/gitlab-com/gl-infra/-/epics/596). Additionally, run `bin/rake gitlab:sidekiq:sidekiq_queues_yml:generate` to regenerate diff --git a/doc/development/stage_group_observability/dashboards/stage_group_dashboard.md b/doc/development/stage_group_observability/dashboards/stage_group_dashboard.md index abc46c52407..7c596e544b5 100644 --- a/doc/development/stage_group_observability/dashboards/stage_group_dashboard.md +++ b/doc/development/stage_group_observability/dashboards/stage_group_dashboard.md @@ -168,7 +168,7 @@ stageGroupDashboards.dashboard('source_code') If you want to see the workflow in action, we've recorded a pairing session on customizing a dashboard, available on [GitLab Unfiltered](https://youtu.be/shEd_eiUjdI). -For deeper customization and more complicated metrics, visit the +For deeper customization and more complicated metrics, see the [Grafonnet lib](https://github.com/grafana/grafonnet-lib) project and the [GitLab Prometheus Metrics](../../../administration/monitoring/prometheus/gitlab_metrics.md#gitlab-prometheus-metrics) documentation. diff --git a/doc/development/stage_group_observability/index.md b/doc/development/stage_group_observability/index.md index 08f751c508e..b275b0bfec2 100644 --- a/doc/development/stage_group_observability/index.md +++ b/doc/development/stage_group_observability/index.md @@ -35,7 +35,7 @@ stage group is comparable to the [monthly availability](https://about.gitlab.com/handbook/engineering/infrastructure/performance-indicators/#gitlabcom-availability) we calculate for GitLab.com, except it's scoped to the features of a group. -To learn more about how we use error budgets, see the +For more information about how we use error budgets, see the [Engineering Error Budgets](https://about.gitlab.com/handbook/engineering/error-budgets/) handbook page. By default, the first row of panels on both dashboards shows the diff --git a/doc/development/testing_guide/contract/consumer_tests.md b/doc/development/testing_guide/contract/consumer_tests.md index 39cc34d6153..60ce71db79d 100644 --- a/doc/development/testing_guide/contract/consumer_tests.md +++ b/doc/development/testing_guide/contract/consumer_tests.md @@ -17,7 +17,7 @@ Then, populate it with the following function and parameters: - [`PactOptions`](#the-pactoptions-parameter) - [`PactFn`](#the-pactfn-parameter) -To learn more about how the contract test directory is structured, see the contract testing [test suite folder structure](index.md#test-suite-folder-structure). +For more information about how the contract test directory is structured, see [Test suite folder structure](index.md#test-suite-folder-structure). ### The `pactWith` function @@ -47,7 +47,7 @@ pactWith( ); ``` -To learn more about how to name the consumers and providers, see contract testing [naming conventions](index.md#naming-conventions). +For more information about how to name consumers and providers, see [Naming conventions](index.md#naming-conventions). ### The `PactFn` parameter diff --git a/doc/development/testing_guide/contract/provider_tests.md b/doc/development/testing_guide/contract/provider_tests.md index 3ce9f91a307..cb3aeae529d 100644 --- a/doc/development/testing_guide/contract/provider_tests.md +++ b/doc/development/testing_guide/contract/provider_tests.md @@ -12,7 +12,7 @@ This tutorial guides you through writing a provider test from scratch. It is a c Provider tests are quite simple. The goal is to set up the test data and then link that with the corresponding contract. Start by creating a file called `get_discussions_helper.rb` under `spec/contracts/provider/pact_helpers/project/merge_request`. Note that the files are called `helpers` to match how they are called by Pact in the Rake tasks, which are set up at the end of this tutorial. -To learn more about how the contract test directory is structured, see the contract testing [test suite folder structure](index.md#test-suite-folder-structure). +For more information about how the contract test directory is structured, see [Test suite folder structure](index.md#test-suite-folder-structure). ### The `service_provider` block @@ -48,7 +48,7 @@ module Provider end ``` -To learn more about how to name the consumers and providers, see contract testing [naming conventions](index.md#naming-conventions). +For more information about how to name consumers and providers, see [Naming conventions](index.md#naming-conventions). ## Configure the test app diff --git a/doc/development/testing_guide/end_to_end/index.md b/doc/development/testing_guide/end_to_end/index.md index 1481b4364a7..77ceb9fa546 100644 --- a/doc/development/testing_guide/end_to_end/index.md +++ b/doc/development/testing_guide/end_to_end/index.md @@ -259,8 +259,7 @@ Learn how to perform [tests that require special setup or consideration to run o ## How do you write tests? -In order to write new tests, you first need to learn more about GitLab QA -architecture. See the [documentation about it](https://gitlab.com/gitlab-org/gitlab-qa/blob/master/docs/architecture.md). +Before you write new tests, review the [GitLab QA architecture](https://gitlab.com/gitlab-org/gitlab-qa/blob/master/docs/architecture.md). After you've decided where to put [test environment orchestration scenarios](https://gitlab.com/gitlab-org/gitlab-qa/tree/master/lib/gitlab/qa/scenario) and [instance-level scenarios](https://gitlab.com/gitlab-org/gitlab-foss/tree/master/qa/qa/specs/features), take a look at the [GitLab QA README](https://gitlab.com/gitlab-org/gitlab/-/tree/master/qa/README.md), |