Extract cron docs from watchers docs #49156
Closed
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
andrershov
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-core-features (:Core/Features/Watcher) |
lcawl
reviewed
Nov 15, 2019
| schedule won't trigger that month. | ||
|
|
||
| |====== | ||
|
|
There was a problem hiding this comment.
It might be nice to add a section or introduction to indicate that the following tables are all examples of cron expressions, unlike the previous tables which were just definitions/explanations.
dakrone
approved these changes
Nov 15, 2019
| [options="header"] | ||
| |====== | ||
| | Cron Expression | Description | ||
| | `0 5 9 * * ?` | Trigger at 9:05 AM every day. |
There was a problem hiding this comment.
Think it's worth it to change this to:
Suggested change
| | `0 5 9 * * ?` | Trigger at 9:05 AM every day. | |
| | `0 5 9 * * ?` | Trigger at 9:05 AM UTC every day. |
just to clarify these examples?
|
|
||
| [source,bash] | ||
| -------------------------------------------------- | ||
| bin/elasticsearch-croneval "0 0/1 * * * ?" |
There was a problem hiding this comment.
It looks like this section was removed but didn't make it into the new docs? Was this a duplicate? I think we should probably still include a blurb for how to run this.
rjernst
added
Team:Data Management
|
Superseded by #56313 |
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.
Today we have cron expression docs live inside watcher docs. Before "Snapshot lifecycle Management" feature watcher was the only user of Cron.
But now SLM uses Cron as well and it references the subsection inside the Watcher trigger docs.
This PR moves Cron expression docs into
elasticsearch-cronevaltool docs. Both watcher and SLM now reference this subsection. All further uses of Cron expression might reference this subsection as well.I'm not sure if
elasticsearch-cronevalcommand docs is the best place for cron expressions docs, need reviewers' opinions on that.This PR also clarifies that all cron schedules are in UTC.
Please let me know you opinion on backporting these changes.
Preview:
http://elasticsearch_49156.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/elasticsearch-croneval.html#cron-expressions