-
Notifications
You must be signed in to change notification settings - Fork 3.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add CronWorkflow stopStrategy docs #12696
base: main
Are you sure you want to change the base?
Conversation
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for updating based off my comments in #12305 (review) !
There's a few more modifications on top of that needed.
Otherwise I haven't had a chance to go through the docs section itself yet. From a glance, it will need some simplification and active voice changes. Also the expression docs should be linked here (see #12617 for examples)
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
Signed-off-by: Eduardo Rodrigues <eduardodbr@hotmail.com>
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Couple of simplifications and clarifications in-line below
docs/cron-workflows.md
Outdated
@@ -103,6 +104,33 @@ For example, with timezone set at `America/Los_Angeles`, we have daylight saving | |||
| | 2 | 2020-11-02 02:01:00 -0800 PST | | |||
| | 3 | 2020-11-03 02:01:00 -0800 PST | | |||
|
|||
### Stopping a `CronWorkflow` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
### Stopping a `CronWorkflow` | |
### Automatically Stopping a `CronWorkflow` |
Manually stopping/suspending can already be done (e.g. argo cron suspsend
), so this should differentiate.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also I'm wondering if stopStrategy
should entirely be renamed to suspendStrategy
to be consistent? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cronworkflow is not set as "suspended", it is just removed from the queue and cannot become active again, so I think it is best to be different.
Signed-off-by: eduardodbr <eduardodbr@hotmail.com>
The suggestions were pushed, thanks for the review! |
@agilgur5 do you think this is good to merge? |
Docs for
stopStrategy
implemented in #12305 to be released on v3.6