Question 1 (structure) - its mainly important that it works for you but I personally like the flatter A) structure - I rarely build with maven while development, hence it wouldn't be an issue to have documentation on the same level - for excluding/including submodules you can introduce a profile
Question 2 (groovy file) - if the module has a lot of groovy files it might be useful to have them separated - question is how the IDEs (ecplise for me) treat the extra groovy structure Cheers - Philipp On 28.10.2010, at 12:40, Dertinger, Matthew wrote: > Magnolians, > > I wanted to pose some questions regarding project structure for Magnolia > Twigs, all feedback is welcome. > > Question 1: > I started to put together a parent pom for Twigs, and in the process I > started thinking that maybe naming the root “magnolia-module-twigs” may not > have been such a good idea. I was kind of hoping to keep the layout similar > to that used by the standard-templating-kit. I was thinking of one of the > following: > > Option A: > magnolia-twigs/ > +- pom.xml (parent pom) > +- bundle/ <-- Contains bundled distribution, static prototype, similar to > the bundle for standard-templating-kit > +- documentation/ <-- Generated using maven-archetype-site-simple, contains > .apt files, site descriptor (site.xml), etc. > +- magnolia-module-twigs/ > +- magnolia-module-twigs-google-maps/ > +- magnolia-module-twigs-social/ > +- magnolia-theme-pop-n-twigs/ <-- This sounds like a kids cereal, with lots > of fiber :) yum! > +- magnolia-twigs-demo-project/ > > Option B: > magnolia-twigs/ > +- pom.xml (parent pom) > +- bundle/ > +- documentation/ > +- modules/ > +- pom.xml <-- parent pom for modules, allows us to build without docs > and bundle, dependency management for all modules > +- magnolia-module-twigs/ > +- magnolia-module-twigs-google-maps/ > +- magnolia-module-twigs-social/ > +- magnolia-theme-pop-n-twigs/ > +- magnolia-twigs-demo-project/ > > I have used Option B in my projects so far and it has worked out well. Does > anyone have an opinion on the options above, do you favor one over the other? > Is there another option you think we should consider? > > Question 2: > Does Magnolia have a directory structure/convention for where to store Groovy > files? > > For instance, Gmaven has the following directory structure: > (more info available here: > http://docs.codehaus.org/display/GMAVEN/Building+Groovy+Projects) > > <project-root>/ > +- pom.xml > +- src/ > +- main/ > | +- groovy/ (source location for Groovy and optional Java sources) > +- test/ > +- groovy/ (source location for Groovy and optional Java test sources) > > I have also seen this structure: > > <project-root>/ > +- pom.xml > +- src/ > | +- main/ > | | +- groovy/ (source location for Groovy sources) > | | +- java/ (source location for Java sources) > | +- test/ > | +- groovy/ (source location for Groovy test sources) > | +- java/ (source location for Java test sources) > > I posed this question to Grégory Joseph, he indicated that there was not yet > a set way to do this with regards to Magnolia. He also pointed to the Groovy > Module, which stores its Groovy files in ./src/*/resources for simplicity. > Does anyone have any thoughts on this? > > > Thanks, > Matt > > > ---------------------------------------------------------------- > For list details see > http://www.magnolia-cms.com/home/community/mailing-lists.html > To unsubscribe, E-mail to: <dev-list-unsubscr...@magnolia-cms.com> > ---------------------------------------------------------------- ---------------------------------------------------------------- For list details see http://www.magnolia-cms.com/home/community/mailing-lists.html To unsubscribe, E-mail to: <dev-list-unsubscr...@magnolia-cms.com> ----------------------------------------------------------------
