Add Contributer/Developer guide/help page to website

[fschueler]

I think it would be helpful to add a contributers/developers page to the docs on the website.
This should explain how to setup a development environment for Peel. how to add Systems etc. and how to setup debugging for example in Intellij.

[aalexandrov]

👍 from my side.

I actually wanted to structure this as a blog post with with a running example based on the recent DStat addition from @verbit, but I am open to other systems if we find a volunteer to do this.

[joh-mue]

+1

I am trying to extend peel to get multiple jobs to run on Yarn concurrently to simulate cluster workloads. For this purpose I would like to be able to debug what I modified in peel.

[aalexandrov]

I think that @akunft had something written up already in the Google doc for the Manual but I cannot find it.

The basic method that I use is to configure a new "Run Configuration" in IntelliJ that executes the command you want to debug and uses $BUNDLE_BIN/bundlename as a current directory.

[aalexandrov]

@joh-mue here is a screenshot of an example "Run configuration" on my machine that starts Yarn. I have similar configurations for each system that I want to test. Note that I am using the classpath of the '-bundle` module and that the *working directory points to the bundle binary location.

If you wish to develop a special Experiment bean I suggest to use exp:run --just and start / stop the associated systems with a dedicated exp:setup and exp:teardown calls.

[akunft]

@aalexandrov yes I did, but we wanted to move it to another section and it somehow got lost... Is there a option to see older versions of an document in google docs?

[aalexandrov]

I think so. You can look at the revision history.

[akunft]

Just saw it, added the section about Setup/run in IDE to the document again under Development

[joh-mue]

Thanks for the help. I tried the above but still get this weird scalac error which I pasted into this gist: https://gist.github.com/joh-mue/d098fcbe35b39d343789

Probably something related to my setup though. I'll try reinstalling everything and see if that helps.

[aalexandrov]

This seems to be a problem with the compilation, not with the run configuration. Try running mvn clean from the project root before you start building the project from IntelliJ.

[trenner]

What version of scala plugin for intellij are you using?
I had some similar problems, but after updating to intelij 15 + scala plugin 2.0.4 it works.

[joh-mue]

I just updated too, rebuild the entire local maven repository, ran mvn clean and donated $5 to apache. Not sure which it was but one of those measures fixed the issue. It's working for me now. Thanks for the advice.

[aalexandrov]

My bet is on mvn clean, although the $5 seems plausible as well.

[sdudoladov]

Are there any other developer guides besides the draft on Google Docs ?

[aalexandrov]

Not really, but contributions are welcome. At the moment the best guide is to look at existing implementations. To work out the details, it helps if you are familiar with the Peel Execution Lifecycle implemented by the suite:run command.