DOCSP-39849: revise job batching docs #2994
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GromNaN
requested changes
Jun 4, 2024
docs/queues.txt
Outdated
Comment on lines
24
to
26
| 'collection' => 'jobs', | ||
| 'queue' => 'default', | ||
| 'retry_after' => 60, |
There was a problem hiding this comment.
In #2985 (comment) we decided with @jmikola to comment optional settings.
Suggested change
| 'collection' => 'jobs', | |
| 'queue' => 'default', | |
| 'retry_after' => 60, | |
| // 'collection' => 'jobs', | |
| // 'queue' => 'default', | |
| // 'retry_after' => 60, |
docs/queues.txt
Outdated
| @@ -35,22 +38,29 @@ the driver in ``config/queue.php``: | |||
| - Description | |||
|
|
|||
| * - ``driver`` | |||
| - **Required**. Specifies the queue driver to use. Must be ``mongodb``. | |||
| - **Required**. Specifies the queue driver to use. The value of | |||
There was a problem hiding this comment.
I find it cumbersome to repeat "Specifies" for every setting.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
norareidy
approved these changes
Jun 4, 2024
docs/queues.txt
Outdated
Comment on lines
25
to
27
| // 'collection' => 'jobs', | ||
| // 'queue' => 'default', | ||
| // 'retry_after' => 60, |
There was a problem hiding this comment.
S: It's a little unclear why these fields are commented out - are they optional? I think either leaving them uncommented and highlighting line 24 or deleting them altogether would be better
There was a problem hiding this comment.
Based on the table below, collection and queue are required so maybe leaving uncommented and highlighting line 24 is the way to go
GromNaN
approved these changes
Jun 20, 2024
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://jira.mongodb.org/browse/DOCSP-39849
Revises docs changes made in #2904
STAGING
Checklist