Commit 57636d29 authored by Amy Qualls's avatar Amy Qualls

Merge branch 'katrinleinweber-repair-link-anchors-docs' into 'master'

Docs: Repair link anchors by lowercasing them

See merge request gitlab-org/gitlab!36344
parents edee2dae e1285c35
...@@ -71,14 +71,14 @@ module WorkerAttributes ...@@ -71,14 +71,14 @@ module WorkerAttributes
# Set this attribute on a job when it will call to services outside of the # Set this attribute on a job when it will call to services outside of the
# application, such as 3rd party applications, other k8s clusters etc See # application, such as 3rd party applications, other k8s clusters etc See
# doc/development/sidekiq_style_guide.md#Jobs-with-External-Dependencies for # doc/development/sidekiq_style_guide.md#jobs-with-external-dependencies for
# details # details
def worker_has_external_dependencies! def worker_has_external_dependencies!
class_attributes[:external_dependencies] = true class_attributes[:external_dependencies] = true
end end
# Returns a truthy value if the worker has external dependencies. # Returns a truthy value if the worker has external dependencies.
# See doc/development/sidekiq_style_guide.md#Jobs-with-External-Dependencies # See doc/development/sidekiq_style_guide.md#jobs-with-external-dependencies
# for details # for details
def worker_has_external_dependencies? def worker_has_external_dependencies?
class_attributes[:external_dependencies] class_attributes[:external_dependencies]
......
...@@ -567,7 +567,7 @@ For monitoring deployed apps, see the [Sentry integration docs](../user/project/ ...@@ -567,7 +567,7 @@ For monitoring deployed apps, see the [Sentry integration docs](../user/project/
- [GDK](https://gitlab.com/gitlab-org/gitlab/blob/master/config/gitlab.yml.example) - [GDK](https://gitlab.com/gitlab-org/gitlab/blob/master/config/gitlab.yml.example)
- Layer: Core Service (Processor) - Layer: Core Service (Processor)
- Process: `sidekiq` - Process: `sidekiq`
- GitLab.com: [Sidekiq](../user/gitlab_com/index.md#Sidekiq) - GitLab.com: [Sidekiq](../user/gitlab_com/index.md#sidekiq)
Sidekiq is a Ruby background job processor that pulls jobs from the Redis queue and processes them. Background jobs allow GitLab to provide a faster request/response cycle by moving work into the background. Sidekiq is a Ruby background job processor that pulls jobs from the Redis queue and processes them. Background jobs allow GitLab to provide a faster request/response cycle by moving work into the background.
......
...@@ -115,6 +115,6 @@ There are multiple ways to find the source of queries. ...@@ -115,6 +115,6 @@ There are multiple ways to find the source of queries.
## See also ## See also
- [Bullet](profiling.md#Bullet) For finding `N+1` query problems - [Bullet](profiling.md#bullet) For finding `N+1` query problems
- [Performance guidelines](performance.md) - [Performance guidelines](performance.md)
- [Merge request performance guidelines](merge_request_performance_guidelines.md#query-counts) - [Merge request performance guidelines](merge_request_performance_guidelines.md#query-counts)
...@@ -741,7 +741,7 @@ GitLab uses [factory_bot](https://github.com/thoughtbot/factory_bot) as a test f ...@@ -741,7 +741,7 @@ GitLab uses [factory_bot](https://github.com/thoughtbot/factory_bot) as a test f
- There should be only one top-level factory definition per file. - There should be only one top-level factory definition per file.
- FactoryBot methods are mixed in to all RSpec groups. This means you can (and - FactoryBot methods are mixed in to all RSpec groups. This means you can (and
should) call `create(...)` instead of `FactoryBot.create(...)`. should) call `create(...)` instead of `FactoryBot.create(...)`.
- Make use of [traits](https://www.rubydoc.info/gems/factory_bot/file/GETTING_STARTED.md#Traits) to clean up definitions and usages. - Make use of [traits](https://www.rubydoc.info/gems/factory_bot/file/GETTING_STARTED.md#traits) to clean up definitions and usages.
- When defining a factory, don't define attributes that are not required for the - When defining a factory, don't define attributes that are not required for the
resulting record to pass validation. resulting record to pass validation.
- When instantiating from a factory, don't supply attributes that aren't - When instantiating from a factory, don't supply attributes that aren't
......
...@@ -17,7 +17,7 @@ These instructions will also work for a self-managed GitLab instance. However, y ...@@ -17,7 +17,7 @@ These instructions will also work for a self-managed GitLab instance. However, y
need to ensure your own [Runners are configured](../../ci/runners/README.md) and need to ensure your own [Runners are configured](../../ci/runners/README.md) and
[Google OAuth is enabled](../../integration/google.md). [Google OAuth is enabled](../../integration/google.md).
**Note**: GitLab's Web Application Firewall is deployed with [Ingress](../../user/clusters/applications.md#Ingress), **Note**: GitLab's Web Application Firewall is deployed with [Ingress](../../user/clusters/applications.md#ingress),
so it will be available to your applications no matter how you deploy them to Kubernetes. so it will be available to your applications no matter how you deploy them to Kubernetes.
## Configuring your Google account ## Configuring your Google account
......
...@@ -53,7 +53,7 @@ RSpec.describe 'Every Sidekiq worker' do ...@@ -53,7 +53,7 @@ RSpec.describe 'Every Sidekiq worker' do
# All Sidekiq worker classes should declare a valid `feature_category` # All Sidekiq worker classes should declare a valid `feature_category`
# or explicitly be excluded with the `feature_category_not_owned!` annotation. # or explicitly be excluded with the `feature_category_not_owned!` annotation.
# Please see doc/development/sidekiq_style_guide.md#Feature-Categorization for more details. # Please see doc/development/sidekiq_style_guide.md#feature-categorization for more details.
it 'has a feature_category or feature_category_not_owned! attribute', :aggregate_failures do it 'has a feature_category or feature_category_not_owned! attribute', :aggregate_failures do
workers_without_defaults.each do |worker| workers_without_defaults.each do |worker|
expect(worker.get_feature_category).to be_a(Symbol), "expected #{worker.inspect} to declare a feature_category or feature_category_not_owned!" expect(worker.get_feature_category).to be_a(Symbol), "expected #{worker.inspect} to declare a feature_category or feature_category_not_owned!"
...@@ -62,7 +62,7 @@ RSpec.describe 'Every Sidekiq worker' do ...@@ -62,7 +62,7 @@ RSpec.describe 'Every Sidekiq worker' do
# All Sidekiq worker classes should declare a valid `feature_category`. # All Sidekiq worker classes should declare a valid `feature_category`.
# The category should match a value in `config/feature_categories.yml`. # The category should match a value in `config/feature_categories.yml`.
# Please see doc/development/sidekiq_style_guide.md#Feature-Categorization for more details. # Please see doc/development/sidekiq_style_guide.md#feature-categorization for more details.
it 'has a feature_category that maps to a value in feature_categories.yml', :aggregate_failures do it 'has a feature_category that maps to a value in feature_categories.yml', :aggregate_failures do
workers_with_feature_categories = workers_without_defaults workers_with_feature_categories = workers_without_defaults
.select(&:get_feature_category) .select(&:get_feature_category)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment