[Yanel-dev] Doc update: Rapid development

[Mehmet Birgi]

Thanks Michi for the suggestions. I am not sure what you meant by "custom
example", but here is the revised version so far:

Rapid Development of Components

When developing Yanel components, often there is no need to recompile
everything once a total build has been done. Components that can be built
separately are *webapp classes*, *resource classes* and *realms*.
Efficiently building webapp classes

Webapp classes are all classes that are under
{yanel.home}/src/webapp/src/java/org/wyona/yanel/servlet. In order to build
and test these classes efficiently, one can run:

{yanel.home}/build.sh compile-webapp copy-basic-webapp-libs
copy-webapp-files-to-tomcat-cluster-node1

instead of running the whole build process. This will build only the webapp
and redeploy it, and should reduce the waiting time from a couple of minutes
to a couple of seconds.
Efficiently building resource classes

Resource classes can be found in separate directories at several locations,
e.g.:

   - {yanel.home}/src/resources
   - {yanel.home}/src/contributions/resources
   - {yanel.home}src/realms/welcome-admin/yanel/resources
   - {yanel.home}src/realms/from-scratch-realm-template/res-types
   - {my.realm}res-types
   - etc...

These classes all have their own build.xml files, so to compile them
efficiently, one can run the build as

{yanel.home}/build.sh -f {path.to.resource.dir}/build.xml

instead of running the whole build process. Again, this will reduce the
building time significantly, as only the changed resource will be built.
Efficiently building single realms

In the same way as building resource classes, it is also possible to build
single realms after editing classes belonging to that realm:

{yanel.home}/build.sh -f {my.realm}/build.xml




On Fri, Mar 26, 2010 at 10:34 AM, Michael Wechner <michael.wechner at wyona.com
> wrote:

> Dear Memo
>
> Thanks for improving this, but I think you should add more examples re the
> resource, in particular a custom example and
> also make it clearer that
>
>
> |{yanel.home}/src/contributions/resources
>
> is not the only directory containing resource types, but also
>
> ||{yanel.home}/src/resources
>
> or
>
> {yanel.home}src/realms/welcome-admin/yanel/resources/
>
>
> or
>
> {my.realm}res-types
>
> etc.
>
> Also you might want to add a note re realms itself, e.g.
>
> {my.realm}build.xml
>
>
> Thanks
>
> Michi
> |
> Mehmet Birgi wrote:
>
>> Hi
>>
>> I have updated the best practices for rapid development (
>> http://yanel.wyona.org/en/documentation/best-practices/rapid-development=
-of-components.html)
>> to be - at least for me - a little clearer. Here is the new version for
>> reviewing:
>>
>>
>>  Rapid Development of Components
>>
>> When developing Yanel components, often there is no need to compile
>> everything. Two cases where this applies are *webapp classes* and *resou=
rce
>> classes*.
>>
>>
>>    Efficiently building webapp classes
>>
>> Webapp classes are all classes that are under
>> |{yanel.home}/src/webapp/src/java/org/wyona/yanel/servlet|. In order to
>> build and test these classes efficiently, one can run:
>>
>> {yanel.home}/build.sh compile-webapp copy-basic-webapp-libs
>> copy-webapp-files-to-tomcat-cluster-node1
>>
>> instead of running the whole build process. This will build only the
>> webapp and redeploy it, and should reduce the waiting time from a couple=
 of
>> minutes to a couple of seconds.
>>
>>
>>    Efficiently building resource classes
>>
>> Resource classes are the classes that are found in separate directories
>> under |{yanel.home}/src/contributions/resources|. These classes all have
>> their own |build.xml| files, so to compile them efficiently, one can run=
 the
>> build as
>>
>> {yanel.home}/build.sh -f src/contributions/resources/{resource.dir.name <
>> http://resource.dir.name>}/build.xml
>>
>>
>> instead of running the whole build process. Again, this will reduce the
>> building time significantly, as only the changed resource will be built.
>>
>>
>> Cheers,
>>
>> Memo
>>
>>
>> --
>> Mehmet Birgi
>> www.wyona.com <http://www.wyona.com>
>>
>>
> --
> Yanel-development mailing list Yanel-development at wyona.com
> http://lists.wyona.org/cgi-bin/mailman/listinfo/yanel-development
>



-- =

Mehmet Birgi
www.wyona.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.wyona.org/pipermail/yanel-development/attachments/2010032=
6/f6eda4b5/attachment-0001.htm