You are viewing a plain text version of this content. The canonical link for it is here.

Posted to issues@metron.apache.org by "Jon Zeolla (Jira)" <ji...@apache.org> on 2020/05/11 15:48:00 UTC

[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&focusedCommentId=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)