How to get up to speed...

[Jason N.]

I loved Joe's presentation (http://rubyhoedown2008.confreaks.com/
videos/10-joe-kutner-ruleby-the-rule-engine-for-ruby-960x368.mp4)...
clear and precise.

I'm trying to get up to speed with Ruleby. Since the presentation,
much has changed as one would anticipate. For instance:
- create_engine is no longer how you instantiate the engine.
- writing rules is now different (looking at the code, looks like
there are 2 DSLs)

But as I can see, there is nothing to help anybody get up to speed
quickly without having to read the source (and even then, where are
the unit tests so I can see how to write a rule properly). Not to
mention RDoc is non-existent.

Libraries need some kind of usage guidance to help others get up to
speed quickly.... is there something (blog post etc) that can do this?

Happy to read the code, but just wondered if there was a quick way to
get up and going.

[Joe Kutner]

Yea, like any good open source product, we are lacking on documentation :)

The github wiki has some stuff:
http://wiki.github.com/mattup/ruleby

Specifically, here are a couple docs on the API/DSL:
http://wiki.github.com/mattup/ruleby/interface-description
http://wiki.github.com/mattup/ruleby/ferrari

There is also a github project that acts as a sample implementation of Ruleby in a Rails app:
http://github.com/noel/Ruleby-Store-Tutorial

I'll keep trying to improve the docs.  But in the meantime, if you have any questions, this group is the place to go!

Thanks for your interest,

Joe

--
You received this message because you are subscribed to the Google Groups "Ruleby" group.
To post to this group, send email to rul...@googlegroups.com.
To unsubscribe from this group, send email to ruleby+un...@googlegroups.com.
For more options, visit this group at http://groups.google.com/group/ruleby?hl=en.

[Raphael Bellec]

Hello, I used a bit ruleby last year and it was great to do what I need.
I am actually setting up a small team in my company who will have to use ruleby. I was thus thinking of writing some documentation for them (simple introduction, tutorials and "navigation" guide to know why there are multiples DSL etc etc). This is maybe an effort that could be helpful for other people. What kind of documentation do you think would be the most interesting ?

I intended to write this initially in french (they are all french), I can write 2 version (french - english).

Regards.

2010/1/13 Joe Kutner <jpku...@gmail.com>

[Joe Kutner]

Raphael,

That would be a fantastic contribution to the project - even if you are only able to provide a French version.  It might be wise to base your tutorials on the examples in the git repo.  Maybe explain what they are doing, and what they are trying to demonstrate.  I'll be happy to explain any of this if you need help.

I wouldn't spend any time discussing the differences between DSLs.  We are really only supporting the Ferrari (array based) DSL now.  Eventually we'll get something better, but the Le Tigre (string based) DSL is not the right approach. 

Again, any contribution is welcomed, and let me know if you need help!

Thanks,

Joe

[boadie]

I would also suggest glancing over the mailing list archive. There has not
been so much traffic that it is hard and Joe and Matt have been great responding
to questions so there are some good threads.

[Noel]

If you have suggestions for the tutorial app, we can also enhance that
with additional use cases, etc.

[Ralphb]

Hello,
I had the opportunity to talk at a ruby and rails meeting in Paris
last week to some people that had problems that could typically be
adressed by a rule engine (smart caches, basic user profiling) it
ended by a one hour talk to 6 people (not that much... but world
domination has to start somewhere !) about ruleby. This confort me in
the idea that this may interest much more people than it does today
(which is also what I have been thinking for 10 years about rule
engines... So maybe I draw the conclusion prior looking to reality !).
I proposed to talk more about this a next time and I am waiting to see
how many peoples are interested.

I was considering a "explain all parts then put everything together"
kind of tuto. This needs the subject to be small and the reader to
concentrate, but it seems to me well adapted to this subject which can
be fairly new for lot of people.

I was considering picking example in Drools or CLIPS but if you have
ideas of example that typically interest ruby peoples (anything around
rails, like the Ruleby-Store-Tutorial or an AAA system may be a good
example) this may be a good way to target more peoples.

I'll keep the group informed.

> >> For more options, visit this group athttp://groups.google.com/group/ruleby?hl=en.

[deeje]

> There is also a github project that acts as a sample implementation of
> Ruleby in a Rails app:http://github.com/noel/Ruleby-Store-Tutorial

Forgive me my newbiness… but where do I put Ruleby in this tutorial to
make it work?

peace

deeje

[Joe Kutner]

If I understand what you are asking, Ruleby would be installed as a gem - just like any other library you might use.  Here is some info on Ruby gems:

http://docs.rubygems.org/

Please correct me if I have misunderstood your question.

--