----------------------------------------------------------- This is an automatically generated e-mail. To reply, visit: https://reviews.apache.org/r/52570/#review163036 -----------------------------------------------------------
Thanks for adding the documentation! docs/learn/documentation/versioned/hdfs/consumer.md (line 26) <https://reviews.apache.org/r/52570/#comment234455> Can you include the diagram from your design document? Or something similar to elaborate how the setup should look like? docs/learn/documentation/versioned/hdfs/consumer.md (line 42) <https://reviews.apache.org/r/52570/#comment234458> Can you add a snippet of the interface here as well? It is easier for the user to skim through. docs/learn/documentation/versioned/hdfs/consumer.md (line 50) <https://reviews.apache.org/r/52570/#comment234460> Replace "users" with "user application". We provide the capability for the user application to get notified when ... Rephrase "To do so, simply implement the interface [EndOfStreamListenerTask]" as "In order to receieve notications on EndOfStream with the task, the user application should simply implement the interface ..." docs/learn/documentation/versioned/hdfs/consumer.md (line 54) <https://reviews.apache.org/r/52570/#comment234461> I think you can skip the "job.properties" file. The readers may easily assume there is a separate properties file. docs/learn/documentation/versioned/hdfs/consumer.md (line 75) <https://reviews.apache.org/r/52570/#comment234462> Typo "configs are required" docs/learn/documentation/versioned/hdfs/consumer.md (line 77) <https://reviews.apache.org/r/52570/#comment234464> I don't think you need to mentioned the JIRA that introduced a feature. If there is documentation related to security in Samza, you can link to it. You can link to the javadoc for SamzaContainerSecurityManager. You can add a brief description of the feature. For example, the SamzaContainer fetches and renews the Kerberos delegation tokens when the job is running in a secure environment. User application needs to specify .. docs/learn/documentation/versioned/hdfs/consumer.md (line 93) <https://reviews.apache.org/r/52570/#comment234465> Can you elaborate the "advanced partitioning" feature here and remove the link for design doc? If it helps, you can just copy-and-paste the design doc content here and edit it :) docs/learn/documentation/versioned/hdfs/consumer.md (line 102) <https://reviews.apache.org/r/52570/#comment234468> Looks like there are more configurations that are mentioned in the configuration table. Can you please add the link to configuration table to imply that? docs/learn/documentation/versioned/hdfs/consumer.md (line 105) <https://reviews.apache.org/r/52570/#comment234466> You can add a link to the design doc pdf here , instead of the JIRA link. - Navina Ramesh On Jan. 24, 2017, 2:07 a.m., Hai Lu wrote: > > ----------------------------------------------------------- > This is an automatically generated e-mail. To reply, visit: > https://reviews.apache.org/r/52570/ > ----------------------------------------------------------- > > (Updated Jan. 24, 2017, 2:07 a.m.) > > > Review request for samza. > > > Bugs: SAMZA-1025 > https://issues.apache.org/jira/browse/SAMZA-1025 > > > Repository: samza > > > Description > ------- > > documentation for hdfs system consumer > > > Diffs > ----- > > docs/learn/documentation/versioned/hdfs/consumer.md PRE-CREATION > docs/learn/documentation/versioned/hdfs/producer.md > b0e936f5b0a9c945ea7f02bfc2536ef50f017bf6 > docs/learn/documentation/versioned/index.html > d0b14ece94341e2cb937cf32db480e69f93303c2 > docs/learn/documentation/versioned/jobs/configuration-table.html > ba5ebbc54b5c64f82f35ed781dad7023a8f920e1 > > Diff: https://reviews.apache.org/r/52570/diff/ > > > Testing > ------- > > N/A > > > Thanks, > > Hai Lu > >