[GitHub] [pulsar] tuteng commented on a change in pull request #5238: [Doc] Add *Flume sink connector guide*

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

tuteng commented on a change in pull request #5238: [Doc] Add *Flume sink connector guide*
URL: https://github.com/apache/pulsar/pull/5238#discussion_r327045814
 
 

 ##########
 File path: site2/docs/io-flume-source.md
 ##########
 @@ -8,14 +8,42 @@ The Flume source connector pulls messages from logs to Pulsar topics.
 
 ## Configuration
 
-The configuration of Flume source connector has the following parameters.
+The configuration of the Flume source connector has the following properties.
 
-### Parameter
+### Property
 
 | Name | Type|Required | Default | Description 
 |------|----------|----------|---------|-------------|
-`name`|String|true|"" (empty string)|Name of the agent
-`confFile`|String|true|"" (empty string)|Configuration file
-`noReloadConf`|Boolean|false|false|Whether to reload configuration file if changed
-`zkConnString`|String|true|"" (empty string)|ZooKeeper connection 
-`zkBasePath`|String|true|"" (empty string)|Base path in ZooKeeper for agent configuration
+`name`|String|true|"" (empty string)|The name of the agent.
+`confFile`|String|true|"" (empty string)|The configuration file.
+`noReloadConf`|Boolean|false|false|Whether to reload configuration file if changed.
+`zkConnString`|String|true|"" (empty string)|The ZooKeeper connection.
+`zkBasePath`|String|true|"" (empty string)|The base path in ZooKeeper for agent configuration.
+
+### Example
+
+Before using the Flume source connector, you need to create a configuration file through one of the following methods.
+
 
 Review comment:
   A link to the [source.conf](https://github.com/apache/pulsar/blob/master/pulsar-io/flume/src/main/resources/flume/source.conf) file can be added here to make it easier for users to understand if and configure `source.conf`.

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