commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <garydgreg...@gmail.com>
Subject Re: [VOTE] Release Apache Commons Weaver 1.0 based on RC3
Date Wed, 12 Mar 2014 12:37:14 GMT
[X] -1 I oppose this release because...

I'm sorry to say but it is not possible to tell how to use this components
by looking at the site.

The text descriptions could not be more terse and is devoid of examples.
Finding the modules requires drilling down the site. The modules AND
examples should be listed in the main menu. Preferably a user docs page
should exist.

Drilling down to the privilizer example source xref [1] is not helpful
since the code has no comments.

There appears to be a hierarchy of modules which is only discoverable by
drilling down the whole site. For example, on

https://people.apache.org/~mbenson/commons-weaver-1.0-rc3/commons-weaver-processor/index.html

there are two modules with the exact same kind of description and no guide
lines for when to use which one, unless you guess by the name of course ;)
No good enough IMO.

The page starts with "This module provides the
org.apache.commons:commons-weaver artifact." which are Maven concepts
related to building Weaver itself or installing it for use in your
IDE/editor. This shows to me that the docs need a "Building" and
"Installing" section like some other sites have which tell you how to do
just that, building and installing.

I do not see how this component can be released without telling folks how
to use it!

Gary

[1]
https://people.apache.org/~mbenson/commons-weaver-1.0-rc3/commons-weaver-modules-parent/commons-weaver-normalizer-parent/commons-weaver-normalizer-example/xref/index.html



On Tue, Mar 11, 2014 at 7:33 PM, Matt Benson <mbenson@apache.org> wrote:

> Apache Commons Weaver 1.0 RC3 is available for review at:
>   https://dist.apache.org/repos/dist/dev/commons/weaver/ (r4624).
>
> Maven artifacts are at:
>
> https://repository.apache.org/content/repositories/orgapachecommons-1018/
>  .
>
> Tested with Oracle JDKs 6, 7 and 8.
>
> The Subversion tag is:
>   http://svn.apache.org/repos/asf/commons/proper/weaver/tags/1.0_RC3/
>  (r1576397).
>
> Site:
>   http://people.apache.org/~mbenson/commons-weaver-1.0-rc3/index.html
>
> RAT Report:
>   http://people.apache.org/~mbenson/commons-weaver-1.0-rc3/rat-report.html
>
> Keys: https://dist.apache.org/repos/dist/release/commons/KEYS
>
> Changes since RC2:
>  - Configured project to run a single all-inclusive RAT report
>  - Added missing license headers
>  - Included issueManagement in POM (and thus in generated site)
>  - Documented resulting need for expanded permgen when generating site
>
> Changes since RC1:
>  - Removed -dist suffix from distribution files
>  - Added release notes to binary distribution
>  - Included project-specific LICENSE.txt and NOTICE.txt in jar artifacts
>  - Restricted checkstyle to run only for relevant modules
>  - Fixed remaining checkstyle errors
>  - Improved (somewhat) overview documentation
>  - Removed license header from release notes
>  - Added FindBugs and PMD reporting
>
> Please review the release candidate and vote.
>   This vote will close no sooner that 72 hours from now, i.e. after 0000UTC
> 15-March 2014
>
>   [ ] +1 Release these artifacts
>   [ ] +0 OK, but...
>   [ ] -0 OK, but really should fix...
>   [ ] -1 I oppose this release because...
>
>   Thanks!
>



-- 
E-Mail: garydgregory@gmail.com | ggregory@apache.org
Java Persistence with Hibernate, Second Edition<http://www.manning.com/bauer3/>
JUnit in Action, Second Edition <http://www.manning.com/tahchiev/>
Spring Batch in Action <http://www.manning.com/templier/>
Blog: http://garygregory.wordpress.com
Home: http://garygregory.com/
Tweet! http://twitter.com/GaryGregory

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message