[jira] [Commented] (FLINK-20799) Restructure TOC of the "Working with state" documentation page

["Svend Vanderveken (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/FLINK-20799?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17261509#comment-17261509 ] 

Svend Vanderveken commented on FLINK-20799:
-------------------------------------------

Hi all,

Any love on that one ? :)

I know it's a bit of a trivial change and every is busy and all. I'm waiting for feedback before starting to work on this.

Cheers,

S

 

> Restructure TOC of the "Working with state" documentation page
> --------------------------------------------------------------
>
>                 Key: FLINK-20799
>                 URL: https://issues.apache.org/jira/browse/FLINK-20799
>             Project: Flink
>          Issue Type: Improvement
>          Components: Documentation
>    Affects Versions: 1.12.0
>            Reporter: Svend Vanderveken
>            Priority: Minor
>
> In the [Working with state|https://ci.apache.org/projects/flink/flink-docs-release-1.12/dev/stream/state/state.html#top] documentation page, the "operator state" section appears twice in the TOC, which makes the logic of the text harder to follow:
>  * Keyed DataStream
>  * Using Keyed State
>  ** State Time-To-Live (TTL)
>  ** State in the Scala DataStream API
>  * Operator State
>  * Broadcast State
>  * Using Operator State
>  ** Stateful Source Functions
> Broadcast state being a special case of Operator state, I suggest I update that page according to the following structure:
>  * Keyed State
>  ** Keyed DataStream
>  ** Using Keyed State
>  *** State Time-To-Live (TTL)
>  *** State in the Scala DataStream API
>  * Operator State
>  ** Using Operator State
>  ** Stateful Source Functions
>  ** Broadcast State
> Also, the "Broadcast State" section is very short and could benefit from a link pointing to the additional information present on the page: [the broadcast state pattern|https://ci.apache.org/projects/flink/flink-docs-release-1.12/dev/stream/state/broadcast_state.html]
> wdyt?
>  



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