db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Greg Monroe" <Greg.Mon...@DukeCE.com>
Subject RE: proposal for reorganizing the Torque site
Date Tue, 17 Jan 2006 22:53:01 GMT
First off, bravo! for all the hard work getting it to 
this point!  I think it's production ready as is.

That said... there are always IMHO things to add.

First, I like the new overview details but IMHO the
Torque "elevator speech" (i.e. how you describe a
project/product in the time it takes to go 3 floors
in an elevator) could use some editorial tweaking.
Not exactly sure what, but maybe more towards how
Torque makes code DB independent and programmer's
life easier.  I'll give it some thought and make 
my suggestion here.

Second, I think that the How-To's are lost by being 
placed in the "All Components" area.  Ideally, they
should be under the main Documentation section, but 
if it's hard, then maybe relabel the All components
link to How-Tos or something that includes How-Tos 
in it.

Next, I first thought that the Criteria How-To
and some othere were missing and then I realized you
had rolled them into the Runtime reference.. nice.
One minor suggestion would be to add an "Overview"
section to this.  Something that would set the 
context for all the other sections.

Finally, just a minor thing.. should the order
be Generator and then Runtime since that's the
learning Torque order?  (Being an Ant user, I
consider the Mavin plug-in as optional reading
...lol 8) ).

> -----Original Message-----
> From: Thomas Fischer [mailto:tfischer@apache.org] 
> Sent: Friday, January 13, 2006 3:14 PM
> To: torque-dev@db.apache.org
> Subject: proposal for reorganizing the Torque site
> Hi,
> In the last months, I grew more and more uncomfortable with 
> the current 
> organisation of the Torque homepage, http://db.apache.org/torque.
> The things I like least about it are
> - when you change to a component of Torque (e.g. the 
> runtime), the menu on 
> the left hand side "jumps" and you cannot get back via the 
> menu to the 
> overview (you have to discover the links in the header)
> - There is a lot of information scattered in the homepage, 
> but it is very 
> difficult to locate the information.
> So I went for it and tried to design a new page organisation, 
> where the 
> issues above are resolved. The suggestion can be found at 
> http://people.apache.org/~tfischer/torque-docs/
> Please have a look and write back whether you like the 
> reorganisation or 
> not. I have rewritten and reviewed a lot of information in 
> the runtime 
> (that was where the chaos was largest because that was once 
> our top-evel 
> page), but of course also the new site is not perfect (though in my 
> opinion it is loads better than our present site). I am 
> grateful for any 
> hint what is missing or wrong (e.g. I did not yet incorporate Greg's 
> suggestion for an ant user guide), but please also judge the general 
> concept.
> Implementation Details:
> The method to avoid the jumping menu is to create a "skeleton menu" 
> for the site which is incorporated in every component 
> (basically this is 
> the part of the menu where all items are closed) The disadvantage of 
> this is that it is very difficult to change that skeleton 
> after publishing 
> the site, so I tried hard to create a very general skeleton.
> I had to create two new subcomponents of Torque for this. One is the 
> tutorial (which in my opinion should live in its own 
> component, anyway), 
> the other is docs-all-components where versioned docs which are not 
> attributable to a single Torque component (e.g. the database 
> howtos) are 
> located.
> This is just a suggestion. I did not check in any of this to svn.
>    I look forward to hear your opinion
>      Thomas
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
> For additional commands, e-mail: torque-dev-help@db.apache.org

Duke CE Privacy Statement
Please be advised that this e-mail and any files transmitted with it are confidential communication
or may otherwise be privileged or confidential and are intended solely for the individual
or entity to whom they are addressed.  If you are not the intended recipient you may not rely
on the contents of this email or any attachments, and we ask that you  please not read, copy
or retransmit this communication, but reply to the sender and destroy the email, its contents,
and all copies thereof immediately.  Any unauthorized dissemination, distribution or copying
of this communication is strictly prohibited.

To unsubscribe, e-mail: torque-dev-unsubscribe@db.apache.org
For additional commands, e-mail: torque-dev-help@db.apache.org

View raw message