Move "Periodic Jobs" section out of README into guide #1175
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
whatyouhide
commented
Nov 7, 2024
| Each part may have multiple rules, where rules are separated by a comma. The allowed values for | ||
| each field are as follows: | ||
|
|
||
| | Field | Allowed Values | |
There was a problem hiding this comment.
Turned some stuff into tables here, I think it looks great.
|
|
||
| This plugin registers workers a cron-like schedule and enqueues jobs automatically. Periodic | ||
| jobs are declared as a list of `{cron, worker}` or `{cron, worker, options}` tuples. | ||
| Periodically enqueue jobs through [cron](https://en.wikipedia.org/wiki/Cron)-based scheduling. |
There was a problem hiding this comment.
Moved some stuff around here, I like the flow now, thoughts?
There was a problem hiding this comment.
Agreed, the new flow is an improvement!
sorentwo
reviewed
Nov 8, 2024
|
@sorentwo updated ✅ |
sorentwo
approved these changes
Nov 11, 2024
|
An excellent start, thank you! |
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.
This is the start of some work on #850. We'll want to split the README out into guides, and the cron plugin seemed like a good candidate to start off—it's isolated and its functionality is self-contained.