[Feedhenry-raincatcher] Raincatcher feedback from a newbie

[Wojciech Trocki]

> A lot of this should probably get added to the feedhenry.org raincatcher
page.  There are a LOT of modules in raincatcher so having the docs be
spread across 20 repos is not idea.

There is so much overhead related with maintaining multiple
repository project that I see that now most of the projects keeping their
core resources (even sometimes unrelated with the core in single repo).
I remember good conversation about it from Eclipse Che, where someone
mentioned really good point against multiple repo setup. Single repo
simplifies development setup,  issue and PR tracking etc.
If we have 20 repos for the moment and we have some common
responsibilities spread across different repositories in organization then
we can always improve it by creating repos for common elements like plugins
repo that would hold all plugins etc. This obviously have some drawbacks
too, but I personally think that single repos are more community friendly
(see Linux as example). I'm not trying to say that we should put all code
into one, but 20 repositories for such platform feature seems too much.

For jenkins project we decided to hold all common files into the single
repo, but have jenkins clients in single repositories as they would have
different release cycle etc.

3.  Feedhenry makes it very difficult to deploy applications which have
> dependencies on auth services.
>

Fully agree after using it and reading our documentation. I heard lots of
people having similar experiences.
We may need to invest some time to improve this.  fh.auth needs to be
little bit more documented and some misleading parts [1]

https://github.com/feedhenry-templates/helloworld-cloud-cluster/blob/master/application.js#L14-L15


Wojciech Trocki
Software Engineer, Red Hat Mobile

On Thu, Jan 26, 2017 at 3:18 PM, paul wright <pwright at redhat.com> wrote:

> +1
> Overview of Module = outline of purpose, limitations/restrictions?
> Do we need   Setup, Troubleshooting sections?
>
> Paul
>
>
> On 26/01/17 14:35, Tom Jackman wrote:
>
> Hi Summers,
>
> I definitely feel we need a lot of work done in the docs side of things
> alright. We should be aiming to have each module's README to be like any
> cordova plugins readme file.
>
> It would probably be a good idea to have the same README template for each
> module too so people know where to look for information no matter what
> module's repo they are on. Some headings could be:
>
>    - Overview of Module
>    - Module Type (Client/ Client & Cloud etc)
>    - API
>    - Code Examples for each Function
>    - Integrating into a larger solution
>    - Upgrade Notes
>    - etc etc
>
>
> Similarly to the RHMAP help documentation, I think we missed a trick by
> not having a section on what the different functions inside of the
> Raincatcher sample solution actually are in the actual docs for developers.
> It jumps straight into the nitty gritty, without pointing out the basics of
> what it actually does. [1]
>
> [1] https://github.com/feedhenry-raincatcher/raincatcher-documentation
>
> --
>
> [image: Red Hat] <http://www.redhat.com/>
>
> Tom Jackman / Associate Software Engineer
> tjackman at redhat.com / 0894751360
>
> *Slack* - @tjackman #rhmap #rhmap-rmad
>
> Red Hat
> Waterford, Ireland.
> www.redhat.com
>
>
> _______________________________________________
> Feedhenry-raincatcher mailing listFeedhenry-raincatcher at redhat.comhttps://www.redhat.com/mailman/listinfo/feedhenry-raincatcher
>
>
>
> _______________________________________________
> 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/20170126/e2fd7d19/attachment.htm>