[docs] Clarify restart strategy defaults set by checkpointing #3059
Conversation
- Added info about checkpointing changing the default restart strategy in places where it was missing: the config page and the section about the fixed-delay strategy - Replaced no-restart with "no restart" so people don't think we're referring to a config value - Replaced invalid <it> html tag with <code> - Fixed bad link to restart strategies page from state.md
|
The changes so far are docs-only, so the CI failure must be unrelated. |
| - `restart-strategy`: Default [restart strategy]({{site.baseurl}}/dev/restart_strategies.html) to use in case no | ||
| restart strategy has been specified for the job. | ||
| The options are: | ||
| - fixed delay strategy: "fixed-delay". |
There was a problem hiding this comment.
Should we use code formatting with backticks instead of " for these as well?
| Per default, the no-restart strategy is used. | ||
| When checkpointing is activated and no restart strategy has been configured, the job will be restarted infinitely often. | ||
| If checkpointing is not enabled, the "no restart" strategy is used. | ||
| If checkpointing is activated and the restart strategy has not been configured, the fixed-delay strategy is used with |
There was a problem hiding this comment.
Should we say "If checkpointing is activated and no restart strategy has been explicitly configured, ..."
|
Thanks for these clarifications. I'm going to merge it with the next batch. In the current master we also have a new checkpoints page at |
|
@uce Thanks. I didn't get an opportunity to address your comments... is there anything you want me to do? |
|
I'm curious as to how you added my commit to If you have a moment can you describe your workflow is so I can understand what's happening behind the scenes? Is it rebase onto master + merge --ff-only or something? Maybe it's due to the fact that Github is only mirroring another repo? I'd appreciate it! |
|
Since the comments were very minor I addressed them myself (used the backticks and skipped the change in "If checkpointing is activated..." as it didn't really improve anything). The work flow was as follows: I checked out your PR branch, rebased it onto master (via GitHub only notices that the changes were merged for merges to master and if the commit hashes are not changed I think. Since I rebased they did change and I needed the manual close. Does this make sense? |
|
It does, thanks! I'll try to remember to include "closes #{pr number}" in my commit messages which might be handy. |
This closes apache#3059.
This closes apache#3059.
strategy in places where it was missing: the config page and the
section about the fixed-delay strategy
referring to a config value
Thanks for contributing to Apache Flink. Before you open your pull request, please take the following check list into consideration.
If your changes take all of the items into account, feel free to open your pull request. For more information and/or questions please refer to the How To Contribute guide.
In addition to going through the list, please provide a meaningful description of your changes.
General
Documentation
Tests & Build
mvn clean verifyhas been executed successfully locally or a Travis build has passed