[FLINK-7301] [docs] Rework state documentation #4441
Conversation
|
CC @alpinegizmo |
There was a problem hiding this comment.
Very nice. But we should add redirects for all the pages being moved, which I believe is the list below. I know I have linked to a bunch of these pages from answers on stackoverflow and from the training site, and I imagine there are links elsewhere on the web.
dev/stream/checkpointing.html
dev/stream/state.html
dev/stream/queryable_state.html
monitoring/large_state_tuning.html
ops/state_backends.html
setup/aws.html
setup/building.html
setup/checkpoints.html
setup/cli.html
setup/checkpoints.html
setup/cluster_setup.html
setup/config.html
setup/deployment.html
setup/docker.html
setup/flink_on_windows.html
setup/gce_setup.html
setup/index.html
setup/jobmanager_high_availability.html
setup/kubernetes.html
setup/mapr_setup.html
setup/mesos.html
setup/savepoints.html
setup/security-ssl.html
setup/yarn_setup.html
| under the License. | ||
| --> | ||
|
|
||
| If your application uses Flink's managed state, it might be necessary to implement a custom serialization logic for special use cases. |
There was a problem hiding this comment.
drop the word "a" in "implement a custom serialization logic" so that it reads "implement custom serialization logic"
| Note that Flink writes state serializers along with the state as metadata. In certain cases on restore (see following | ||
| subsections), the written serializer needs to be deserialized and used. Therefore, it is recommended to avoid using | ||
| anonymous classes as your state serializers. Anonymous classes do not have a guarantee on the generated classname, | ||
| varying across compilers and depends on the order that they are instantiated within the enclosing class, which can |
There was a problem hiding this comment.
"varying across compilers and depends" ==> "which varies across compilers and depends"
docs/dev/stream/state/index.md
Outdated
| - When training a machine learning model over a stream of data points, the state holds the current version of the model parameters. | ||
| - When historic data needs to be managed, the state allows efficient access to events occured in the past. | ||
|
|
||
| Flink needs to be aware of the state in order to make state fault tolerant using [checkpoints](checkpointing.html) and allow [savepoints]({{ site.baseurl }}/ops/state/savepoints.html) of streaming applications. |
There was a problem hiding this comment.
"and to allow [savepoints]"
|
@alpinegizmo I thought about adding redirects, but we would be in redirect hell if we would add every single page in the future. Actually, only links to the master docs change and we should not use links to master docs in trainings/stackoverflow anyway. Proper links to released docs remain unchanged. |
|
@twalthr Duh, of course, you're right. +1 |
|
Thanks @alpinegizmo. I will merge this now. |
What is the purpose of the change
This PR restructures state related documentation pages. It introduces some state introduction page and moves some files (from
setup/toops/) according to the new documentation structure.Brief change log
Documentation changes only.
Verifying this change
Built with built script and links checked.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): noDocumentation