Ok - this is all very close. Regardless of names...
We need a home page with a summary of everything. A little intro, a little news, etc. Like the current one.
And I'd like to see a page describing what Velocity is and where it can be used. I like the text of the current page "Design". Which seems to have very little to do with design or architecture.
And finally, a page that tells new users how to download the software, install it, what to read first would be useful. A Quick Start in other words. I like the idea of combining "Overview", a link to Download. The content from "Install" is probably not very relevant to new users, it's really developer info on "Building Velocity".
WILL
----- Original Message ----- From: "Tim Colson (tcolson)" <[EMAIL PROTECTED]>
To: "Velocity Developers List" <[email protected]>
Sent: Friday, May 06, 2005 2:12 PM
Subject: RE: site table of contents
At this point, I think we're more or less agreeing... but I think it's just kind of hard to communicate some of what we mean versus what we're saying. :-)
I thought about this a little more. Tim said: <item name="Home" /> <item name="Quick Start" /> [Will] suggest we do this slight change instead <item name="Home" /> <item name="Quick Start" /> <item name="Overview" />
I'm thinking Home / Quick Start / Overview all smell very very very similar.... and might all fit into HOME.
The API doc section here (http://jakarta.apache.org/velocity/getting-started.html -> the ) could simply be absorbed into the Developers Guide)
Sites can go in the Wiki - let people edit this themselves.
I think that's a great idea. +1
"Overview" becomes the home page. "Design" becomes "Overview". Tim had suggested "Design" should become "Architecture". I suggest keeping it in the top section as it's nice to give users a quick overview of how Velocity works right at the start.
I'm cool with keeping it in the top section, but still think "Architecture" better describes the content. :-) ("Design" smells a bit to much like "HTML Designer"... which makes me think of "interior design"...which makes me think of carpet and couches. ;-)
And "Home" usually is the "overview" ... so I'd rather just have the overview info on Home (basically the "What is Velocity?" and "Getting Started" sections from elsewhere)
I put this in the Wiki so we can remember it.
Good idea... I'll add some notes there.
Cheers, Timo
----- Original Message ----- From: "Tim Colson (tcolson)" <[EMAIL PROTECTED]>
To: "Velocity Developers List" <[email protected]>
Sent: Friday, May 06, 2005 10:44 AM
Subject: RE: site table of contents
> NEW XDOCS: > * Getting Starting with Web Applications +1 -- I would suggestion "mentioning" VelocityServlet only to say, "VelocityViewServlet replaces VelocityServlet. Don't use VelocityServlet, it's old crufty and deprecated... and if you ask about it on the mailing list...we'll tell you to read this: Don't use it!" <grin>
> * TODO (convert to a Road Map) I had suggested we move over to Jira, had positive feedback on that -- just no word from Geir (I emailed him offlist, still no official response here, but my understanding is that he wouldn't mind.)
We could put in the infrastructure@ request to move... and then leverage the Jira Roadmap feature.
http://jira.atlassian.com/browse/JRA?report=com.atlassian.jira .plugin.sy stem.project:roadmap-panel
I think we'd still want a page with a high-level Summary, but the Jira Roadmap is a great communication tool. And I'd put this into the Wiki.
> NEW WIKI PAGES > MOVE TO WIKI FROM DOCS +1 -- I sometimes think SVN should just contain code + docs + examples... and most everything else move to the wiki where it's easier (in my opinion as a non-committer) to make updates. Sometimes. Not always. ;-)
> REMOVE ENTIRELY > * Specification (out of date, no one cares) > * Migration to Velocity (WebMacro conversion - who uses WM?) > * Contributors (very out of date) +1
A simpler left-hand-navigation might be nice too. Less options so maybe folks will find (and read) what they need to before coming to the list.
> <menu name="Getting Started"> > <item name="Overview" /> > <item name="Getting Started" /> > <item name="Web Applications" /> > <item name="Download" /> + > <item name="Install" /> > <item name="Design" /> > <item name="FAQ (Wiki)" /> * > </menu>
-1 on duplicating "Getting Started" as the header and a sub-head.
How about:
<menu name="Velocity"> <item name="Home" /> <item name="Quick Start" /> <item name="Web Applications" /> <item name="News & Sites" /> <item name="FAQ" /> </menu>
I'm thinking on the Home page leave "What is" from the main page, and add first heading of "Getting Started". Move news and powered by stuff onto the "News & Sites" page. Move "Design" down into the Docs menu, and rename to "Architecture". Put Download & Install stuff into "Quick Start".
BTW -- we ought to use a more direct link to downloads http://jakarta.apache.org/site/downloads/downloads_velocity-engine.cgi
Cheers, Timo
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
