[hotfix][docs]Review to reduce passive voice, improve grammar and formatting #5277
Conversation
This file contains hidden or 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
greghogan
reviewed
Jan 10, 2018
| [Savepoints](../ops/state/savepoints.html) are **manually triggered checkpoints**, which take a snapshot of the program and write it out to a state backend. They rely on the regular checkpointing mechanism for this. During execution, programs are periodically snapshotted on the worker nodes and produce checkpoints. You only need the last completed checkpoint for recovery, and you can safely discard older checkpoints as soon as a new one is completed. | ||
|
|
||
| Savepoints are similar to these periodic checkpoints except that they are **triggered by the user** and **don't automatically expire** when newer checkpoints are completed. Savepoints can be created from the [command line](../ops/cli.html#savepoints) or when cancelling a job via the [REST API](../monitoring/rest_api.html#cancel-job-with-savepoint). | ||
| Savepoints are similar to these periodic checkpoints except that they are **triggered by the user** and **don't automatically expire** when newer checkpoints are completed. You can create savepoints can from the [command line](../ops/cli.html#savepoints) or when canceling a job via the [REST API](../monitoring/rest_api.html#cancel-job-with-savepoint). |
Contributor
There was a problem hiding this comment.
"savepoints can" -> "savepoints"
| handover and buffering, and increases overall throughput while decreasing latency. | ||
| The chaining behavior can be configured; see the [chaining docs](../dev/datastream_api.html#task-chaining-and-resource-groups) for details. | ||
| handover and buffering and increases overall throughput while decreasing latency. | ||
| You can configure the chaining behavior, read the [chaining docs](../dev/datastream_api.html#task-chaining-and-resource-groups) for details. |
Contributor
There was a problem hiding this comment.
Preserve the semi-colon?
| You can configure the chaining behavior, read the [chaining docs](../dev/datastream_api.html#task-chaining-and-resource-groups) for details. | ||
|
|
||
| The sample dataflow in the figure below is executed with five subtasks, and hence with five parallel threads. | ||
| Five subtasks execute the sample data flow in the figure below with five parallel threads. |
Contributor
There was a problem hiding this comment.
The community as well as other projects refer to "dataflow" extensively (also below).
|
|
||
| There is always at least one Job Manager. A high-availability setup will have multiple JobManagers, one of | ||
| which one is always the *leader*, and the others are *standby*. | ||
| There is always at least one Job Manager. A high-availability setup should have multiple JobManagers, one of |
Contributor
There was a problem hiding this comment.
"A high-availability setup should have multiple JobManagers" is, in general, not true -- this is a detail that depends on the underlying cluster management framework.
I suggest reworking as follows:
There is always at least one JobManager, but some [high-availability setups]({{ site.baseurl }}/ops/jobmanager_high_availability.html) will have multiple JobManagers.
|
|
||
| As a rule-of-thumb, a good default number of task slots would be the number of CPU cores. | ||
| With hyper-threading, each slot then takes 2 or more hardware thread contexts. | ||
| As a rule-of-thumb, a reasonable default number of task slots would be the number of CPU cores. With hyper-threading, each slot then takes 2 or more hardware thread contexts. |
Contributor
There was a problem hiding this comment.
Preserve the line split? I'm not sure what the second sentence is saying. Typically hyper-threads are reported as separate cores so would not each slot take a single hardware thread context?
| stores data in an in-memory hash map, another state backend uses [RocksDB](http://rocksdb.org) as the key/value store. | ||
| In addition to defining the data structure that holds the state, the state backends also implement the logic to | ||
| take a point-in-time snapshot of the key/value state and store that snapshot as part of a checkpoint. | ||
| The exact data structures which store the key/values indexes depends on the chosen [state backend](../ops/state/state_backends.html). One state backend stores data in an in-memory hash map, another state backend uses [RocksDB](http://rocksdb.org) as the key/value store. In addition to defining the data structure that holds the state, the state backends also implement the logic to take a point-in-time snapshot of the key/value state and store that snapshot as part of a checkpoint. |
Contributor
There was a problem hiding this comment.
Preserve the line splits? The conversion to HTML ignores single newlines.
Contributor
|
I'm closing this as "Abandoned", since there is no more activity and the code base has moved on quite a bit. Please re-open this if you feel otherwise and work should continue. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Small review of the runtime concept doc to reduce passive voice, reduce future tense, improve grammar and formatting. Let me know if it needs backporting to any other branch or if there are any other issues