[GitHub] [rocketmq-streams] duhenglucky commented on a change in pull request #58: Add a quick start which contain some examples.

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

duhenglucky commented on a change in pull request #58:
URL: https://github.com/apache/rocketmq-streams/pull/58#discussion_r706547856



##########
File path: README.md
##########
@@ -7,7 +7,7 @@
 [![Twitter Follow](https://img.shields.io/twitter/follow/ApacheRocketMQ?style=social)](https://twitter.com/intent/follow?screen_name=ApacheRocketMQ)
 
 ## [中文文档](./README-Chinese.md)
-## [Quick Start](./QUICKSTART.md)
+## [Quick Start](./quick_start.md)

Review comment:
       New doc name show be updated in the license exclude check config

##########
File path: rocketmq-streams-examples/README.md
##########
@@ -0,0 +1,67 @@
+## rocketmq-streams-examples
+
+### 1、fileSource example
+```java
+public class FileSourceExample {
+    public static void main(String[] args) {
+        DataStreamSource source = StreamBuilder.dataStream("namespace", "pipeline");
+        source.fromFile("/your/file/path", false)

Review comment:
       Provide a sample file here?

##########
File path: rocketmq-streams-examples/README.md
##########
@@ -0,0 +1,67 @@
+## rocketmq-streams-examples

Review comment:
       With these samples, I still don't know how to construct the input or what expected results I can get.

##########
File path: rocketmq-streams-examples/README.md
##########
@@ -0,0 +1,67 @@
+## rocketmq-streams-examples
+
+### 1、fileSource example
+```java
+public class FileSourceExample {
+    public static void main(String[] args) {
+        DataStreamSource source = StreamBuilder.dataStream("namespace", "pipeline");
+        source.fromFile("/your/file/path", false)
+                .map(message -> message)
+                .toPrint(1)
+                .start();
+    }
+}
+
+```
+
+
+### 2、rocketmq window example
+```java
+public class RocketmqWindowTest {
+    public static final String NAMESRV_ADDRESS = "127.0.0.1:9876";
+    public static final String RMQ_TOPIC = "NormalTestTopic";
+    public static final String RMQ_CONSUMER_GROUP_NAME = "group-01";
+    public static final String TAGS = "*";
+
+    /**
+     * 1、before run this case, make sure some data has already been rocketmq.
+     * 2、rocketmq allow create topic automatically.
+     */
+    public static void main(String[] args) {
+        DataStreamSource source = StreamBuilder.dataStream("namespace", "pipeline");
+
+        source.fromRocketmq(
+                RMQ_TOPIC,

Review comment:
       It will be better if you can provide the method of how to send messages on this topic and the format of this message. 

##########
File path: quick_start.md
##########
@@ -0,0 +1,71 @@
+## rocketmq-streams 快速搭建
+---
+### 前言
+本文档主要介绍如何基于rocketmq-streams快熟搭建流处理任务。
+
+

Review comment:
       Maybe a rocketmq install doc link will be useful for the new rocketmq user.




-- 
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.

To unsubscribe, e-mail: dev-unsubscribe@rocketmq.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org