You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@jakarta.apache.org by Kief Morris <ki...@bitbull.com> on 2002/01/08 04:19:48 UTC

Proposal: Component survey

I've been meaning to trawl through the jakarta subprojects looking for 
components that could be suitable for using in a project of mine. It
occurs to me that having an inventory of components could be a useful
thing for Jakarta, both for general developers who may be overwhelmed
by what's there, and to make Jakarta subproject developers more aware
of what's available so they can avoid duplication.

So I'm proposing to put together a list of components. This is more than
the projects list on the home page, since it's an attempt to delve into 
functionality built by subprojects which aren't necessarily considered 
products. Examples include validator packaging, pooling, etc. This
isn't limited to things which are neatly packaged for reuse, or even
necessarily completely functional: it's code that has been written for
the subproject which might be applicable for other projects.

The methodology would be to get developers from each subprojects
to throw out lists of applicable code, and I will coalate it and make
a page for the site. I can't promise it will be speedily done, due to
time constraints, but if anyone wants to pitch in to get it done more
quickly, that'd be cool by me.

Risks:

- Maintenance will be a bitch, chances are it will be out of date most
  of the time. I'll try to revisit it from time to time, and of course people
  should update it themselves (or submit patches) as they find stuff
  that needs to be added or changed.

- This won't solve the problem of duplication, which still requires 
  developers to do extra work to make code reusable, forgoe reinventing 
  code, not to mention actually thinking to review the list before launching
  into new code. But it should at least raise awareness.

Despite these problems, I think it'd be worth having around.

Info we'd need on each component (comments and suggestions, please?):
- Title (a short phrase, e.g. "object pooling")
- Description
- Subproject
- Where is it (e.g. package name, class name(s), etc. Doesn't need to be
  comprehensive, just a pointer for someone to find it and start looking at it)
- Dependencies (mainly other projects/external packages, e.g. JDOM)

Kief


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Proposal: Component survey

Posted by "Geir Magnusson Jr." <ge...@optonline.net>.
On 1/7/02 11:49 PM, "Kief Morris" <ki...@bitbull.com> wrote:

> Jeff Turner typed the following on 03:16 PM 1/8/2002 +1100
>>   This will be a dynamic catalog, like Bugzilla and Jyve,
>>   similar in functionality to download.com, cpan.org, or
>>   SourceForge.net.  New entries may be added by Jakarta committers,
>>   developers, and users.  Entries by developers and users will be
>>   approved by a committer before being made public."
> ...
>> So if you want to do this, Commons is the place to do it. I volunteer to
>> do the Avalon bits (Berin outlined the reusable stuff recently).
> 
> Writing a dynamic catalog sounds like too much work for this purpose,
> unless anyone can suggest a package to use. An XML file in jakarta-site2,
> while not as searchable as a dynamic solution, will be a snap to implement,
> and fulfill all of the requirements other than being dynamic (i.e. the normal
> patch process allows anyone to add an entry, while requiring committer
> approval).
> 
> I've already started on a file to get the format worked out. Using the current
> vsl template for the jakarta site doesn't look like the way to go: it requires
> hand 
> coding the table, which muddles the presentation with the data too much for
> my liking. A formatting-free XML data file for the components list would make
> it easy to build different "sortings" of the data, e.g. list by project and by
> functional categories.
> 
> Does anyone object to my making a separate template, probably splitting
> common formatting into an include file?

<advertisement>

It would be interesting to see if we can use DVSL to transform your
formatting free XML data into something that works via the VSL.  I'll help
if you are interested.  Feel free to say no :)

</advertisment>

-- 
Geir Magnusson Jr.                                     geirm@optonline.net
System and Software Consulting
Be a giant.  Take giant steps.  Do giant things...


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Proposal: Component survey

Posted by Kief Morris <ki...@bitbull.com>.
Jeff Turner typed the following on 03:16 PM 1/8/2002 +1100
>   This will be a dynamic catalog, like Bugzilla and Jyve,
>   similar in functionality to download.com, cpan.org, or
>   SourceForge.net.  New entries may be added by Jakarta committers,
>   developers, and users.  Entries by developers and users will be
>   approved by a committer before being made public."
...
>So if you want to do this, Commons is the place to do it. I volunteer to
>do the Avalon bits (Berin outlined the reusable stuff recently).

Writing a dynamic catalog sounds like too much work for this purpose,
unless anyone can suggest a package to use. An XML file in jakarta-site2, 
while not as searchable as a dynamic solution, will be a snap to implement, 
and fulfill all of the requirements other than being dynamic (i.e. the normal 
patch process allows anyone to add an entry, while requiring committer 
approval).

I've already started on a file to get the format worked out. Using the current
vsl template for the jakarta site doesn't look like the way to go: it requires hand 
coding the table, which muddles the presentation with the data too much for 
my liking. A formatting-free XML data file for the components list would make 
it easy to build different "sortings" of the data, e.g. list by project and by 
functional categories.

Does anyone object to my making a separate template, probably splitting 
common formatting into an include file? 

Kief


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Proposal: Component survey

Posted by Jeff Turner <je...@socialchange.net.au>.
This idea was (is) part of the Commons charter:

  "(1.5.2) the directory 

   The subproject will also catalog packages and other resources
   available to the public related to other Jakarta subprojects and ASF
   projects.  This will be a dynamic catalog, like Bugzilla and Jyve,
   similar in functionality to download.com, cpan.org, or
   SourceForge.net.  New entries may be added by Jakarta committers,
   developers, and users.  Entries by developers and users will be
   approved by a committer before being made public."

   -- http://jakarta.apache.org/commons/charter.html


So if you want to do this, Commons is the place to do it. I volunteer to
do the Avalon bits (Berin outlined the reusable stuff recently).

--Jeff


On Tue, Jan 08, 2002 at 05:19:48AM +0200, Kief Morris wrote:
> I've been meaning to trawl through the jakarta subprojects looking for 
> components that could be suitable for using in a project of mine. It
> occurs to me that having an inventory of components could be a useful
> thing for Jakarta, both for general developers who may be overwhelmed
> by what's there, and to make Jakarta subproject developers more aware
> of what's available so they can avoid duplication.
...
> Kief

--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>


Re: Proposal: Component survey

Posted by Jon Scott Stevens <jo...@latchkey.com>.
on 1/7/02 7:19 PM, "Kief Morris" <ki...@bitbull.com> wrote:

> Despite these problems, I think it'd be worth having around.

Then take the reigns and just do it the way that you think it should be
done. No need for a proposal.

-jon


--
To unsubscribe, e-mail:   <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>