See inline: On Thu, Jun 5, 2014 at 10:15 AM, Gary Gregory <garydgreg...@gmail.com> wrote:
> Yeah, well, multi-module sites is not something easy to get right in Maven > IMO. This site in an example because it seems to have three levels and it > is hard to navigate. > > When I look at the page: > > https://people.apache.org/~mbenson/commons-weaver-1.1-rc1/index.html > > how do I find the modules? I have to scan the text, which is OK since I am > reading it. But this could be better. > > We say: > > "Apache Commons Weaver consists of: > > - Core Framework > - Weaver Modules > - Maven Plugin > - Antlib" > > But these should be links! > Done; these are now links to anchors at the relevant parts of the index page, which contain links elsewhere. > Links in the menu would be good. > When you are in a module, a link back to the main site would be good as > well. > This already existed in the upper right banner. I played a bit with Maven site breadcrumbs to try and repeat it but I haven't had any luck. > It is hard to navigate the site, here is the worst example: > > You start at the main page: > > https://people.apache.org/~mbenson/commons-weaver-1.1-rc1/index.html > > where you read: > > "Weaver Modules > A number of Weaver Modules > <https://people.apache.org/%7Embenson/commons-weaver-1.1-rc1/commons-weaver-modules-parent/index.html> > are provided by the Commons Weaver project." > > So I click on Weaver Modules > <https://people.apache.org/%7Embenson/commons-weaver-1.1-rc1/commons-weaver-modules-parent/index.html> > which takes me to: > > > https://people.apache.org/~mbenson/commons-weaver-1.1-rc1/commons-weaver-modules-parent/index.html > The page has ONE sentence that says: > > "his is the parent Apache Maven module for the weaver modules provided > with Apache Commons Weaver. See Modules > <https://people.apache.org/%7Embenson/commons-weaver-1.1-rc1/commons-weaver-modules-parent/modules.html> > ." > > Then when you go to the Modules > <https://people.apache.org/%7Embenson/commons-weaver-1.1-rc1/commons-weaver-modules-parent/modules.html> > page, you get a table with links to 6 other modules. > > This is all hard to navigate and confusing IMO. > > Why not give the whole structure of what is available on the main page? > I had hoped to avoid the need for future manual upkeep in the event that we, e.g., add another module. > > I would also expect the LHS menu to have a tree for all these links. > I have added an additional "Project Structure" LHS menu that explicitly points to the individual weaver modules that currently exist. I would still kind of like to avoid locking the site into the necessity for future lockstep updates of both site.xml AND index.md in the event a new weaver module is added. WDYT? Matt > This might just be a case where Maven's out of the box site is lame. > > Gary > > > > On Thu, Jun 5, 2014 at 11:00 AM, Matt Benson <gudnabr...@gmail.com> wrote: > >> During the vote for the 1.0 release, one of your complaints that led to >> your -1 was that "finding the modules requires drilling down on the site." >> I took this to mean you did not find the modules link helpful and >> therefore >> removed it in favor of direct and explicit text in the project overview. >> Perhaps a wireframe would better describe how you'd like this information >> presented. >> >> Thanks, >> Matt >> >> >> On Thu, Jun 5, 2014 at 9:07 AM, Gary Gregory <garydgreg...@gmail.com> >> wrote: >> >> > How do I find these modules from the main site? I expect to see them in >> the >> > left hand side menu. >> > >> > Gary >> > >> > >> > On Wed, Jun 4, 2014 at 5:27 PM, Matt Benson <mben...@apache.org> wrote: >> > >> > > As this is a multimodule component, report content tends to be more >> > correct >> > > when relegated to the module level. Please see: >> > > >> > > >> > > >> > >> http://people.apache.org/~mbenson/commons-weaver-1.1-rc1/commons-weaver-processor/project-reports.html >> > > >> > > >> > >> http://people.apache.org/~mbenson/commons-weaver-1.1-rc1/commons-weaver-modules-parent/commons-weaver-privilizer-parent/commons-weaver-privilizer-api/project-reports.html >> > > >> > > >> > >> http://people.apache.org/~mbenson/commons-weaver-1.1-rc1/commons-weaver-modules-parent/commons-weaver-privilizer-parent/commons-weaver-privilizer/project-reports.html >> > > >> > > >> > >> http://people.apache.org/~mbenson/commons-weaver-1.1-rc1/commons-weaver-modules-parent/commons-weaver-normalizer-parent/commons-weaver-normalizer/project-reports.html >> > > >> > > >> > >> http://people.apache.org/~mbenson/commons-weaver-1.1-rc1/commons-weaver-maven-plugin/project-reports.html >> > > >> > > >> > >> http://people.apache.org/~mbenson/commons-weaver-1.1-rc1/commons-weaver-antlib-parent/commons-weaver-antlib/project-reports.html >> > > * >> > > >> > > I'll go ahead and include these links in future VOTE emails for this >> and >> > > other multimodule components. >> > > >> > > *The clirr report has actually been suppressed (as far as possible) in >> > the >> > > Antlib because the clirr-maven-plugin cannot handle dependencies in >> > > provided scope (namely, the Ant API) that are exposed in the public >> API. >> > > [weaver] 1.1 declares org.apache.ant:ant in compile scope, so we >> should >> > be >> > > able to use clirr here going forward. >> > > >> > > Thanks for looking, >> > > Matt >> > > >> > > >> > > On Wed, Jun 4, 2014 at 4:12 PM, Emmanuel Bourg <ebo...@apache.org> >> > wrote: >> > > >> > > > Le 04/06/2014 23:02, Gary Gregory a écrit : >> > > > > aaaaaalmost -1 because there is no Clirr report on the site so I >> > cannot >> > > > > tell if 1.1 breaks or maintains BC. >> > > > >> > > > Commons Weaver 1.0 has been released 3 months ago, I don't think it >> > > > would be fair to block the release for a breaking change with such a >> > > > young component. >> > > > >> > > > Emmanuel Bourg >> > > > >> > > > >> > > > >> --------------------------------------------------------------------- >> > > > To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org >> > > > For additional commands, e-mail: dev-h...@commons.apache.org >> > > > >> > > > >> > > >> > >> > >> > >> > -- >> > E-Mail: garydgreg...@gmail.com | ggreg...@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 >> > >> > > > > -- > E-Mail: garydgreg...@gmail.com | ggreg...@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 >
