Github user justinleet commented on the issue:
https://github.com/apache/metron/pull/852
Looks like @merrimanr commented on the email thread, so I'll copy it here
for posterity.
> I wrote the ReadMeUtils class a long time ago as a way to make documenting
the REST endpoints easier. The Controller class methods are annotated so
that endpoint documentation is displayed in Swagger but it is also
duplicated in the README. It seemed like a good idea at the time to
provide a utility to make this easier so that you only had to document in
one place. It was actually helpful (to me anyways) when we first
introduced a large number of REST endpoints and saved some tedious
copy/pasting.
>
> In hindsight, there was no way of enforcing that we use the utility along
with the `README.vm` template. People intuitively edit the README.md
instead and the template quickly became stale. Eventually I got tired of
keeping the template in sync so I stopped using it as well. This class can
(and should) be safely removed.
I'd say just dump the template and the utility in this PR, since you'd
already either have to clean it up or wait for another PR anyway.
---
