[
https://issues.apache.org/jira/browse/METRON-2244?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Otto Fowler updated METRON-2244:
--------------------------------
Description:
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.
was:
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.
> 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.2#803003)
