[jira] [Commented] (METRON-2244) [BRO-KAFKA-PLUGIN] Docker Scripts should have documenation
[ https://issues.apache.org/jira/browse/METRON-2244?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17104675#comment-17104675 ] Jon Zeolla commented on METRON-2244: Ok, I agree it's a good backlog item. > [BRO-KAFKA-PLUGIN] Docker Scripts should have documenation > -- > > Key: METRON-2244 > URL: https://issues.apache.org/jira/browse/METRON-2244 > Project: Metron > Issue Type: Improvement >Reporter: Otto Fowler >Priority: Minor > > The scripts, have comments inline, but they require going through the code. > - The Apache Yetus > [ShellDocs](https://yetus.apache.org/documentation/0.11.0/shelldocs/) > - [TomDoc.sh](https://github.com/tests-always-included/tomdoc.sh) > These would allow javadoc like functionality, and produce markdown such that > the github site would be documented. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (METRON-2244) [BRO-KAFKA-PLUGIN] Docker Scripts should have documenation
[ https://issues.apache.org/jira/browse/METRON-2244?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17104647#comment-17104647 ] Otto Fowler commented on METRON-2244: - I think it would be nice, but is not a high priority > [BRO-KAFKA-PLUGIN] Docker Scripts should have documenation > -- > > Key: METRON-2244 > URL: https://issues.apache.org/jira/browse/METRON-2244 > Project: Metron > Issue Type: Improvement >Reporter: Otto Fowler >Priority: Major > > The scripts, have comments inline, but they require going through the code. > - The Apache Yetus > [ShellDocs](https://yetus.apache.org/documentation/0.11.0/shelldocs/) > - [TomDoc.sh](https://github.com/tests-always-included/tomdoc.sh) > These would allow javadoc like functionality, and produce markdown such that > the github site would be documented. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (METRON-2244) [BRO-KAFKA-PLUGIN] Docker Scripts should have documenation
[ https://issues.apache.org/jira/browse/METRON-2244?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=17104606#comment-17104606 ] Jon Zeolla commented on METRON-2244: [~otto] do you think this is still necessary? > [BRO-KAFKA-PLUGIN] Docker Scripts should have documenation > -- > > Key: METRON-2244 > URL: https://issues.apache.org/jira/browse/METRON-2244 > Project: Metron > Issue Type: Improvement >Reporter: Otto Fowler >Priority: Major > > The scripts, have comments inline, but they require going through the code. > - The Apache Yetus > [ShellDocs](https://yetus.apache.org/documentation/0.11.0/shelldocs/) > - [TomDoc.sh](https://github.com/tests-always-included/tomdoc.sh) > These would allow javadoc like functionality, and produce markdown such that > the github site would be documented. -- This message was sent by Atlassian Jira (v8.3.4#803005)
[jira] [Commented] (METRON-2244) Bro Kafka Plugin Docker Scripts should have documenation
[ https://issues.apache.org/jira/browse/METRON-2244?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16920132#comment-16920132 ] Otto Fowler commented on METRON-2244: - [~zeo...@gmail.com] > Bro Kafka Plugin Docker Scripts should have documenation > > > Key: METRON-2244 > URL: https://issues.apache.org/jira/browse/METRON-2244 > Project: Metron > Issue Type: Improvement >Reporter: Otto Fowler >Priority: Major > > The scripts, have comments inline, but they require going through the code. > The Apache Yetus > [ShellDocs](https://yetus.apache.org/documentation/0.11.0/shelldocs/) tool > would allow javadoc like functionality, and produce markdown such that the > github site would be documented. -- This message was sent by Atlassian Jira (v8.3.2#803003)
