Extract cron docs from watchers docs#49156
Conversation
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-core-features (:Core/Features/Watcher) |
| 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
left a comment
There was a problem hiding this comment.
LGTM, I left two comments though, for the clarification one either way is fine, I think the elasticsearch-croneval example should be added back though (unless we were removing a duplicate)
| [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:
| | `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.
|
Superseded by #56313 |
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