Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-6848] Update managed state docs #4072

Closed

Conversation

Fokko
Copy link
Contributor

@Fokko Fokko commented Jun 4, 2017

Hi guys,

I would like to add an example of how to work with managed state in Scala. The code is tested locally and might be a nice addition to the docs.

Cheers,
Fokko Driesprong

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

    • The pull request references the related JIRA issue ("[FLINK-XXX] Jira title text")
    • The pull request addresses only one issue
    • Each commit in the PR has a meaningful commit message (including the JIRA id)
  • Documentation

    • Documentation has been added for new functionality
    • Old documentation affected by the pull request has been updated
    • JavaDoc for public methods has been added
  • Tests & Build

    • Functionality added by the pull request is covered by tests
    • mvn clean verify has been executed successfully locally or a Travis build has passed

@Fokko Fokko force-pushed the fd-update-raw-and-managed-state-docs branch from 8103fc2 to f6e184a Compare June 4, 2017 14:14
@tzulitai
Copy link
Contributor

tzulitai commented Jun 7, 2017

Hi @Fokko, thanks a lot for this contribution!

The current changes look good. However, while you're on it, what do you think about also adding a Scala counterpart example for the other code snippets on the page (e.g. managed operator state, source functions)?

The changes right now are good as is, but I prefer not to merge a "partially documented Scala example", which may give the wrong impression that Scala works only for some cases. What do you think?

@Fokko
Copy link
Contributor Author

Fokko commented Jun 7, 2017

Hi @tzulitai,

I fully agree. Give me some time to work on the other Scala examples, I need to make sure that they are working properly. I'll wrap it up this week. I'll update the commit and rebase with master.

Cheers, Fokko

@Fokko Fokko force-pushed the fd-update-raw-and-managed-state-docs branch from f6e184a to 639ba3e Compare June 9, 2017 13:19
Add an example of how to work with managed state in Scala.
@Fokko
Copy link
Contributor Author

Fokko commented Jun 9, 2017

Hi @tzulitai,

I've added some more Scala examples. If you are still missing something, please let me know.

Kind regards, Fokko

@Fokko Fokko force-pushed the fd-update-raw-and-managed-state-docs branch from 639ba3e to 5020589 Compare June 9, 2017 13:22
@tzulitai
Copy link
Contributor

Thanks a lot @Fokko! This looks very good. +1.

Merging this ...

@asfgit asfgit closed this in 23c82e3 Jun 13, 2017
asfgit pushed a commit that referenced this pull request Jun 13, 2017
Add an example of how to work with managed state in Scala.

This closes #4072.
@Fokko Fokko deleted the fd-update-raw-and-managed-state-docs branch January 15, 2019 00:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants