db-torque-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Thoralf Rickert" <thoralf.rick...@cadooz.de>
Subject AW: proposal for reorganizing the Torque site
Date Mon, 16 Jan 2006 10:45:46 GMT

I think, it's a good idea to reorganize the website. I'd a look and two or three comments:

- When you select the "Documentation" link in the menu you see a lot of options in the content
(Runtime, Generator and so on). When you click on one of this options the menu changes and
you see the selected option also in the menu. I think this isn't 'ergonomic'. First you have
to change your focus from the menu to the content and then the menu-content changes in a way
that you wonder why you've to change your focus. Also you've to go back to the first documentation
content page to reach another tree in the documentation (for example when you want to switch
from runtime to generator). I think, it's better, when the menu shows always all possible
(main) options, like this:

     Torque 3.2 Runtime
     Torque 3.2 Generator
     Older Torque Releases

...maybe without version number...

- Then - if possible - paths are nice features to view the current position on the site. Above
the menu there is enough space to insert a path like this:

   Home / Documentation / Torque 3.2 / Runtime

I think, this could be an additional way to show the user where he is.

- The next point is more content based. There is a menu point called Wiki which points to
a Wiki. I'm not sure if I understand this wiki system. Is it a user communication platform
or a new documentation area. Should the wiki not be part of the documetation tree? And is
it really useful to have two different documentation systems (I'm sure there are some very
useful hints in the wiki that are not part of the offical documentation and vice versa).

Also I think, the documetation is really much too maven oriented. It's really easy to work
with torque and ant. I think, this should be more highlighted.


> -----Urspr√ľngliche Nachricht-----
> Von: Thomas Fischer [mailto:tfischer@apache.org] 
> Gesendet: Freitag, 13. Januar 2006 21:14
> An: torque-dev@db.apache.org
> Betreff: 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

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

View raw message