Skip to content

Commit b3208ef

Browse files
authored
Merge pull request rails#51120 from skipkayhil/hm-aj-q-links
Add links to config.active_job.default_queue_name
2 parents e18203e + d212c0b commit b3208ef

File tree

1 file changed

+32
-9
lines changed

1 file changed

+32
-9
lines changed

guides/source/configuring.md

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1304,7 +1304,9 @@ Allows specifying the maximum number of records that will be destroyed in a back
13041304

13051305
#### `config.active_record.queues.destroy`
13061306

1307-
Allows specifying the Active Job queue to use for destroy jobs. When this option is `nil`, purge jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`). It defaults to `nil`.
1307+
Allows specifying the Active Job queue to use for destroy jobs. When this option
1308+
is `nil`, purge jobs are sent to the default Active Job queue (see
1309+
[`config.active_job.default_queue_name`][]). It defaults to `nil`.
13081310

13091311
#### `config.active_record.enumerate_columns_in_select_statements`
13101312

@@ -2266,7 +2268,9 @@ config.action_mailbox.incinerate_after = 14.days
22662268

22672269
#### `config.action_mailbox.queues.incineration`
22682270

2269-
Accepts a symbol indicating the Active Job queue to use for incineration jobs. When this option is `nil`, incineration jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`).
2271+
Accepts a symbol indicating the Active Job queue to use for incineration jobs.
2272+
When this option is `nil`, incineration jobs are sent to the default Active Job
2273+
queue (see [`config.active_job.default_queue_name`][]).
22702274

22712275
The default value depends on the `config.load_defaults` target version:
22722276

@@ -2277,7 +2281,9 @@ The default value depends on the `config.load_defaults` target version:
22772281

22782282
#### `config.action_mailbox.queues.routing`
22792283

2280-
Accepts a symbol indicating the Active Job queue to use for routing jobs. When this option is `nil`, routing jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`).
2284+
Accepts a symbol indicating the Active Job queue to use for routing jobs. When
2285+
this option is `nil`, routing jobs are sent to the default Active Job queue (see
2286+
[`config.active_job.default_queue_name`][]).
22812287

22822288
The default value depends on the `config.load_defaults` target version:
22832289

@@ -2428,7 +2434,10 @@ Specifies whether the mailer templates should perform fragment caching or not. I
24282434

24292435
#### `config.action_mailer.deliver_later_queue_name`
24302436

2431-
Specifies the Active Job queue to use for the default delivery job (see `config.action_mailer.delivery_job`). When this option is set to `nil`, delivery jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`).
2437+
Specifies the Active Job queue to use for the default delivery job (see
2438+
`config.action_mailer.delivery_job`). When this option is set to `nil`, delivery
2439+
jobs are sent to the default Active Job queue (see
2440+
[`config.active_job.default_queue_name`][]).
24322441

24332442
Mailer classes can override this to use a different queue. Note that this only applies when using the default delivery job. If your mailer is using a custom job, its queue will be used.
24342443

@@ -2713,6 +2722,8 @@ Can be used to change the default queue name. By default this is `"default"`.
27132722
config.active_job.default_queue_name = :medium_priority
27142723
```
27152724

2725+
[`config.active_job.default_queue_name`]: #config-active-job-default-queue-name
2726+
27162727
#### `config.active_job.queue_name_prefix`
27172728

27182729
Allows you to set an optional, non-blank, queue name prefix for all jobs. By default it is blank and not used.
@@ -2895,7 +2906,9 @@ config.active_storage.content_types_allowed_inline = %w(image/png image/gif imag
28952906

28962907
#### `config.active_storage.queues.analysis`
28972908

2898-
Accepts a symbol indicating the Active Job queue to use for analysis jobs. When this option is `nil`, analysis jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`).
2909+
Accepts a symbol indicating the Active Job queue to use for analysis jobs. When
2910+
this option is `nil`, analysis jobs are sent to the default Active Job queue
2911+
(see [`config.active_job.default_queue_name`][]).
28992912

29002913
The default value depends on the `config.load_defaults` target version:
29012914

@@ -2906,15 +2919,23 @@ The default value depends on the `config.load_defaults` target version:
29062919

29072920
#### `config.active_storage.queues.mirror`
29082921

2909-
Accepts a symbol indicating the Active Job queue to use for direct upload mirroring jobs. When this option is `nil`, mirroring jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`). The default is `nil`.
2922+
Accepts a symbol indicating the Active Job queue to use for direct upload
2923+
mirroring jobs. When this option is `nil`, mirroring jobs are sent to the
2924+
default Active Job queue (see [`config.active_job.default_queue_name`][]). The
2925+
default is `nil`.
29102926

29112927
#### `config.active_storage.queues.preview_image`
29122928

2913-
Accepts a symbol indicating the Active Job queue to use for preprocessing previews of images. When this option is `nil`, jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`). The default is `nil`.
2929+
Accepts a symbol indicating the Active Job queue to use for preprocessing
2930+
previews of images. When this option is `nil`, jobs are sent to the default
2931+
Active Job queue (see [`config.active_job.default_queue_name`][]). The default
2932+
is `nil`.
29142933

29152934
#### `config.active_storage.queues.purge`
29162935

2917-
Accepts a symbol indicating the Active Job queue to use for purge jobs. When this option is `nil`, purge jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`).
2936+
Accepts a symbol indicating the Active Job queue to use for purge jobs. When
2937+
this option is `nil`, purge jobs are sent to the default Active Job queue (see
2938+
[`config.active_job.default_queue_name`][]).
29182939

29192940
The default value depends on the `config.load_defaults` target version:
29202941

@@ -2925,7 +2946,9 @@ The default value depends on the `config.load_defaults` target version:
29252946

29262947
#### `config.active_storage.queues.transform`
29272948

2928-
Accepts a symbol indicating the Active Job queue to use for preprocessing variants. When this option is `nil`, jobs are sent to the default Active Job queue (see `config.active_job.default_queue_name`). The default is `nil`.
2949+
Accepts a symbol indicating the Active Job queue to use for preprocessing
2950+
variants. When this option is `nil`, jobs are sent to the default Active Job
2951+
queue (see [`config.active_job.default_queue_name`][]). The default is `nil`.
29292952

29302953
#### `config.active_storage.logger`
29312954

0 commit comments

Comments
 (0)