[GitHub] [flink] aljoscha commented on issue #7811: [FLINK-11672][examples] Add example for streaming operators's connect

[GitBox <gi...@apache.org>]

aljoscha commented on issue #7811: [FLINK-11672][examples] Add example for streaming operators's connect
URL: https://github.com/apache/flink/pull/7811#issuecomment-470571276
 
 
   I'm sorry, but I have to close this. I put down some words about what I think good examples should look like:
   
   Examples should be self-contained and not require systems other than Flink to run. Except for examples that show how to use specific connectors, like the Kafka connector. Sources/sinks that are ok to use are `StreamExecutionEnvironment.socketTextStream`, which should not be used in production but is quite handy for exploring how things work, and file-based sources/sinks. (For streaming, there is the continuous file source)
   
   Examples should also not be pure toy-examples but strike a balance between real-world code and purely abstract examples. The WordCount example is quite long in the tooth by now but it’s a good showcase of simple code that highlights functionality and can do useful things.
   
   Examples should also be heavy in comments. They should describe the general idea of the example in the class-level Javadoc and describe what is happening and what functionality is used throughout the code. The expected input data and output data should also be described.
   
   Examples should include parameter parsing, so that you can run an example (from the Jar that is created for each example using `bin/flink run path/to/myExample.jar --param1 … --param2`.
   
   I hope you can understand.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services