METRON-1239 Drop extra dev environments #852
Conversation
I think you missed the inventory/quick-dev-platform stuff |
Thanks @ottobackwards . I just pushed that fix, plus some other little things I found. |
+1 by inspection |
Hi @nickwallen , I found one more reference to quick dev - here. Also, I could see that the contents within site/current-book needs an update, since it does not have the changes. Does |
I was confused about that README.vm file. Any idea what that is for?
I left everything under site/current-book untouched because I thought we only change that on a release. But I could be wrong about that. |
I am not entirely sure, @nickwallen . I could find a lot of similarities between this README.vm and the main Metron REST README.md though. |
Glancing briefly, it looks like 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 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. |
Looks like @merrimanr commented on the email thread, so I'll copy it here for posterity.
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. |
The issue is that we should use this type of operation, but do it as part of maven no? |
It doesn't seem that the utility is useful enough to maintain anymore. It had value once, but not any longer. |
no, i mean auto documentation of the rest stuff ( and stellar stuff ) from maven builds is a good idea™ |
i'm not saying keep this utility |
My preference would be to just remove the endpoint documentation from the REST README and point users to Swagger where it's provided in context and easier to read. I see no value in duplicating that documentation. |
The api should be documented without requiring the installation of the product. |
We can tackle the issue of documenting in a discuss thread. I'm not going to tackle that issue on this PR. |
agreed, didn't meet to hijack. my +1 stands |
No problem @ottobackwards . I just deleted the ReadMeUtils and README.vm files in the latest commit. I assume that whatever approach we take for documenting, we want to get rid of these files. If anyone disagrees with the latest commit, just let me know. |
+1 by inspection. Great job, @nickwallen |
+1 (non-binding) @nickwallen . This is a much needed fix since it is now straight-forward to anyone new and wanting to try Metron. |
Per the previous discussion referenced in JIRA, this PR drops support for the Quick Dev and Code Lab environments. These have been effectively dead for quite a long time.
I tested this by performing a Full Dev deployment and Amazon EC2 deployment just to make sure I didn't delete anything that I should not have.
I'd really like to get the metron-deployments directory cleaned-up and reorganized to make it easier for new users to build and deploy Metron. This is the first step.
For all changes: