[jira] [Created] (FLINK-22797) Improve incremental checkpoints documentation

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Created] (FLINK-22797) Improve incremental checkpoints documentation

Shang Yuanchun (Jira)
Nicolaus Weidner created FLINK-22797:
----------------------------------------

             Summary: Improve incremental checkpoints documentation
                 Key: FLINK-22797
                 URL: https://issues.apache.org/jira/browse/FLINK-22797
             Project: Flink
          Issue Type: Improvement
          Components: Documentation, Runtime / Checkpointing
            Reporter: Nicolaus Weidner


Information on incremental checkpoints is somewhat scattered and hard to find in the documentation. In particular, the main page on checkpoints [1] should contain at least a short description of incremental checkpoints. They are currently mentioned in only one sentence, without any further explanation.
A very short summary with a link to the RocksDB section [2] would suffice, since they are specific to that state backend.

They are also mentioned on the config pages [3 and 4], which likewise contain incomplete information and no link ("may not be supported by every state backend").

One basically has to follow the above clues and deduce that there may be more information in the state backends section.

[1] [https://ci.apache.org/projects/flink/flink-docs-release-1.13/docs/ops/state/checkpoints/]

[2] [https://ci.apache.org/projects/flink/flink-docs-release-1.13/docs/ops/state/state_backends/#incremental-checkpoints]

[3] [https://ci.apache.org/projects/flink/flink-docs-release-1.13/docs/dev/datastream/fault-tolerance/checkpointing/]

 [4] https://ci.apache.org/projects/flink/flink-docs-release-1.13/docs/deployment/config/



--
This message was sent by Atlassian Jira
(v8.3.4#803005)