[
https://issues.apache.org/jira/browse/METRON-1239?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16270712#comment-16270712
]
ASF GitHub Bot commented on METRON-1239:
----------------------------------------
Github user justinleet commented on the issue:
https://github.com/apache/metron/pull/852
Glancing briefly, it looks like `ReadMeUtils` uses it as a template for the
metron-rest README.md. Just running the main in there overwrites the
metron-rest README.md. Which seems very odd, given that `ReadMeUtils` is in
the test package.
There seems to be no documentation of this class, or its purpose, and I
didn't dig enough into the code to figure it out. Even not knowing the details
and assuming I'm not misreading what's happening, I don't like that there's an
expectation of editing a `README.vm` file, then running a program to produce
the final output `README.md`. `README.md` can vary independently of
`README.vm`. And it already has.
It's outside the scope of this ticket, but at minimum, that class needs to
be moved out of test, it needs to be actually documented what the purpose of it
is, the steps to use it, etc. Right now, though, unless someone comes up with a
compelling reason not to, I'm in favor of killing it entirely. I don't ever see
that being properly managed, even if it does have some utility built in.
> Drop extra dev environments
> ---------------------------
>
> Key: METRON-1239
> URL: https://issues.apache.org/jira/browse/METRON-1239
> Project: Metron
> Issue Type: Bug
> Reporter: Justin Leet
>
> Per [list
> discussion|https://lists.apache.org/thread.html/953431c50263817e2bd2e03012dcd1e6af74e38f120eeae198bea720@%3Cdev.metron.apache.org%3E],
> we want to kill the extra dev environments to make our installation and dev
> paths more obvious.
> This consists of:
> * Kill quick-dev-platform
> * Kill codelab-platform
> * Update any source documentation
> * Update wiki documentation, which may be just clearing things out. It's
> possible things on the wiki should just live in the site-book, so feel free
> to move things to source if it's appropriate to do so.
> * Potentially document differences between these environments and full dev if
> we think there's anything useful. This is probably optional, since I think
> it's mainly relevant to codelab's Ansible skiptags which I think it's just
> entirely pointless.
> There's probably also some additional things surrounding quick-dev building
> and setup that we may or may not want to purge as part of this.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
