search

rpbouman / kettle-cookbook

Automatically exported from code.google.com/p/kettle-cookbook
GNU Lesser General Public License v3.0
46 stars 36 forks source link

Can docs be generated from a repository now? #43

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
Now that this ticket has been fixed: (PDI4.2)

http://jira.pentaho.com/browse/PDI-5521

Will it soon be possible to generate doco direct from a repository?

(Assuming the other issue with PDI4.2 which Tom raised has been fixed!)

Original issue reported on code.google.com by d.e.kee...@gmail.com on 2 Aug 2011 at 10:32

GoogleCodeExporter commented 9 years ago 
Hi Dan, 

well, yes and no. While the new step in 4.2 offers one way of solving this, it 
would also require (virtually) all of kettle-cookbook to be rewritten. 
Eventually that is what should be done, but for that purpose it makes most 
sense to make a new branch, since it will also break backwards compatibility 
(currently cookbook works on kettle 3.2 and up)

There is however an alternative path, that relies on first exporting a 
repository to a folder, and documenting the folder. This can be done with 
another project, krex: http://code.google.com/p/krex/

Granted, that is not exactly the same thing, since the documentation will not 
reflect the fact that the files came originally from a repository. But the 
directory structure of the repository will be preserved, I guess that is the 
most important feature.

Bart donated a job that essentially executes krex and cookbook in sequence. 
However, I wasn't satisfied with that 100% - I would rather keep a top level 
document-all job and let parameters decide whether the krex step should be 
executed. 

However, I haven't found time to rework this properly yet. It shouldn't be too 
hard but I don't have the time right now.

Would you be willing to give krex a go, and then run cookbook on that result? 
If the result is satisfactory then I can consider spending some time to make it 
all work together again (or if you feel like taking this on, that's fine too, 
you're welcome).

thanks, Roland.

Original comment by roland.bouman on 2 Aug 2011 at 1:09

GoogleCodeExporter commented 9 years ago 
Ok, thanks Roland, I shall give that a try.

Original comment by d.e.kee...@gmail.com on 2 Aug 2011 at 1:37

GoogleCodeExporter commented 9 years ago 
Dan, is the proposed solution acceptable? Please let me know if I should keep 
this issue open.

Original comment by roland.bouman on 21 Jan 2012 at 9:20

GoogleCodeExporter commented 9 years ago 
yes thats fine thanks Roland. Sorry for the slow reply!
I have been using krex quite a bit - not just for this, but handy as a 
backup/archiving solution from a db repo.

Original comment by d.e.kee...@gmail.com on 12 Feb 2012 at 7:53

GoogleCodeExporter commented 9 years ago 
Hi Dan! thanks for the reply. I'm glad krezx is working out for you.

I'm going to close the issue for now, we can re-open if we feel we need to 
improve this.

Original comment by roland.bouman on 12 Feb 2012 at 1:17