[Feedhenry-raincatcher] User and Development documentation improvements

[Niall Donnelly]

+1

I agree that there is no "Hello World" tutorial project that consumes one
or two of our existing modules with a user-defined module that interacts
with both. I agree that we need to have a tutorial that goes from 0 to
something useful to introduce the concepts/good practice of Raincatcher
development.

I think the best tutorial to try would be to combine the
raincatcher-workorder and raincatcher-workflow modules with a user-created
module to deal with rendering a custom form to deal with a single step
(e.g.
https://github.com/feedhenry-raincatcher/raincatcher-vehicle-inspection).
This would introduce the user to using the mediator to maintain
loose-coupling between modules.

We have some challenges at the moment around clearly defining the
boundaries between module and application code. This is something that we
will be tackling.

Niall

On Mon, Jan 23, 2017 at 2:40 PM, Summers Pittman <supittma at redhat.com>
wrote:

> We've added a few new people to the team (myself included) and there has
> been some discuss on the getting start / user / developer experience in the
> project.
>
> So, what do you guys think can help?
>
> One thing I am missing is a good tutorial that takes people from a running
> RHMAP instance with 0 projects through writing a Raincatcher project that
> solves some real problem.  Right now it is really unclear what modules are
> needed for a project, how Raincatcher integrates into existing projects,
> and when should a developer add a module.
>
> A second point on the documentation / tutorial situation is when would a
> user want to write their own Raincatcher module vs when could they "get by"
> with using our modules.  The current docs and demos are really unclear on
> that (from my POV)
>
> What other issues and potential fixes do you guys see?
>
> Summers
>
>
>
> _______________________________________________
> Feedhenry-raincatcher mailing list
> Feedhenry-raincatcher at redhat.com
> https://www.redhat.com/mailman/listinfo/feedhenry-raincatcher
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/feedhenry-raincatcher/attachments/20170123/5f652105/attachment.htm>