CiviCRM Data Integration - Documentation

[capo]

We'll publish in a few days the first stable version of CiviCRM Data Integration and I'd like to create a few documents explaining the project. May the End user projects be the right place to place them? What structure do you think it should have? I've been thinking in something like:

CiviCRM Data Integration
- What is it for? (Introduction)
- How to Install? (Installation)
- Good Practices
- Examples and Utilities

[Michael McAndrew]

Hey Carlos,

Documentation structure sounds good at a first glance - basically whatever works for you.

In terms of where to put it, hmmm, you are a trailblazer and although we have asked the question of where to document extensions, we have not yet answered it very well!

I agree the Wiki is a good place to put it to start and I think we should put it in: http://wiki.civicrm.org/confluence/display/CRMDOC rather than http://wiki.civicrm.org/confluence/display/CRM (note the subtle difference).

For now, you might want to create a page Extensions documentation and then add a child page CiviCRM Data Integration (I'm presuming it is an extension? but let me know if not and I will revise my advice).

Michael

[capo]

The plugin is an extension of Pentaho Data Integration. It works within Kettle, not within CiviCRM. From a development perspective, the place to document it is probably the place where Kettle extensions are but, as long as it's interesting for CiviCRM users rather that for Kettle users, from the users perspective, it would be better to document it as if it was a CiviCRM extension.

Is it ok if I create the Extensions Documentation you suggested, and I specify it's not exactly a CiviCRM extension but an addon that allows you to connect the CiviCRM API from within Kettle?