You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@jakarta.apache.org by Henri Yandell <ba...@generationjava.com> on 2003/01/31 04:28:59 UTC
The Jakarta Site Was: [Discussion] (Fake)Forrest for Jakarta!
[Welcome to session #7829 of the open source UN]
While I agree with Dion that the look and feel is secondary to content,
unification of labels is the most important thing. Users should expect a
project site to contain a certain set of content types, and a certain name
for each content type.
Actually, I'm utterly agreeing with Dion, it just seemed like a bad habit
to get into this early in the game, so I had to begin by disagreeing.
However, a consistent skin might actually be the best way to get a
consistently labelled and functional site together.
Now I get to disagree with Dion :) His list of important things, the ones
Maven produce, are by and large not important. The important things are
the ones the user cares about:
1) Where do I download?
2) Has their been a release?
3) Where are the tutorials/documentation?
4) How do I complain about a bug?
5) Where do I ask a question?
and then more minor questions like:
6) So who is behind Project X?
7) What Apache community does Project X belong to?
Currently, very few of these are well represented across the site.
Generally this is a fault of the new looks and feels, the old ones managed
to at least maintain consistent labelling and functionality.
Examples:
Alexandria uses the old look and feel, but fails to maintain the same
navigation.
Ant. Confusion to user? Should this be listed as a project on Jakarta, or
should this be an alumni? This is a fault of the front page. Generally Ant
has good links of the nav-bar, are they consistent with anyone else? They
are quite close to the front page.
Avalon. Look and feel is a mix between the old and the new. Quite nice.
However it fails to match the navigation structure of Ant and the old
site.
BCEL. Mavenised? There is no download opption on the front page. This is
the biggest problem on sites of this look and feel, user's cannot download
the product.
BSF. Old style. Nav-bar relatively the same as the front page.
.... and the others are no better ....
Then the front-page. Dominated by news making it hard to see the welcome.
Those who can't do, complain. But I'm happy to be a member of both sets. I
believe the first step is to actually try to cross-manage the site. Tbh, I
think we could go a lot further wrong than by listing out an information
architecture for the site [I borrowed this from the OReilly Info-Arch
book: http://www.generationjava.com/articles/web/infoArch.shtml].
Once a site-wide contract for labelling and minimum functionality is
ironed out, each particular look and feel, project and generational tool
are free to enhance it as much as they want, as long as they:
eg) Provide a link called 'Download nightly build' or whatever.
Hen
On Fri, 31 Jan 2003 dion@multitask.com.au wrote:
> Content of the site is far more important to me than the skin.
>
> I'd much rather we had all projects/sites listing a common, agreed upon
> set of information that is useful. For example, the set of reports maven
> produces under the heading Project Info (see
> http://jakarta.apache.org/turbine/maven/project-info.html ), along with
> source cross reference and javadocs, cvs activity reporting, unit test and
> 'style conformance'.
>
> Skins are secondary for me. If we could get consistent content across
> Jakarta, having a consistent look and feel would be the next step. But
> having everything look pretty but be incomplete is not much of a step up.
>
> So, how about getting some consistency in our navigation and content as
> part of the process?
> --
> dIon Gillard, Multitask Consulting
> Blog: http://www.freeroller.net/page/dion/Weblog
> Work: http://www.multitask.com.au
>
>
> Glen Stampoultzis <tr...@iprimus.com.au> wrote on 31/01/2003 12:44:53
> PM:
>
> > Hi. I think this is important and I would love to see some unification
> of
> > skins on Apache. While we may choose to use different tools to build
> our
> > sites but I think we should push to make the look of the project
> > consistent. The current mess of different skins makes the site look
> sloppy.
> >
> > Agree/disagree? Lets hear your opinion.
> >
> > Regards,
> >
> > Glen Stampoultzis
> >
> >
> > At 08:42 AM 30/01/2003 +0100, you wrote:
> > >Hi all!
> > >
> > >I saw the "Tapestry" discussion, and this remindet me, that I wanted to
> > >"carry" FakeForrest to Jakarta!
> > >
> > >So what is it? Simple: It's a set of 2 Velocity/Anakia template-files
> and
> > >some images. The Velocity templates are build upon the Jakarta-ones and
> > >follow the Jakarta-Anakia-DTD!
> > >
> > >What does it? It renders Anakia-build websites with the (current - with
> some
> > >small modifications - see below) Forrest skin.
> > >
> > >Where can I find it? We currently use this to build the
> > >http://ant.apache.org website so you can preview the result there and
> the
> > >sources are in the Ant-cvs
> > >http://cvs.apache.org/viewcvs/jakarta-ant/xdocs/stylesheets/.
> > >
> > >Why should we use it? IMHO it is the FASTEST way to provide a nice,
> > >functional and consistent look of the entire xxx.apache.org website!
> > >
> > >Are there any limitations? Yes: Currently there are no multiple tabs
> for
> > >menues on the left side, but this can easyly be solved by allowing
> multiple
> > >menu-sections in the proect.xml
> > >
> > >Additionally: We (Conor ;)) recently fixed some incompatibilities with
> the
> > >HTML 4.01 standard so it now generates validatable HTML 4.01 code! It's
> > >proved, it works, it's nice ;).
> > >
> > >Remark: I do not see Fake-Forrest as the final solution, but its a nice
> and
> > >fast way in moving to a nice new, consisten etc. look of the Apache
> website,
> > >as I said before!
> > >
> > >Thoughts?
> > >Christoph
> > >
> > >---------------------------------------------------------------------
> > >To unsubscribe, e-mail: general-unsubscribe@jakarta.apache.org
> > >For additional commands, e-mail: general-help@jakarta.apache.org
> >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: general-unsubscribe@jakarta.apache.org
> > For additional commands, e-mail: general-help@jakarta.apache.org
> >
>
> > ForwardSourceID:NT000AB40A
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: general-unsubscribe@jakarta.apache.org
> For additional commands, e-mail: general-help@jakarta.apache.org
>
>
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@jakarta.apache.org
For additional commands, e-mail: general-help@jakarta.apache.org
Re: The Jakarta Site Was: [Discussion] (Fake)Forrest for Jakarta!
Posted by Henri Yandell <ba...@generationjava.com>.
On Fri, 31 Jan 2003 dion@multitask.com.au wrote:
> Henri Yandell <ba...@generationjava.com> wrote on 31/01/2003 02:28:59 PM:
>
> How about we give these items some names:
Sounds good.
> > 1) Where do I download?
> Downloads
> > 2) Has their been a release?
> Release Notes
Possibly this should be 'Status' as projects may not have had a release.
I'm thinking that this section is more:
Status: We are working on version 3.0. It's aimed to contain blah blah,
world peace, profitable websites and no arguments.
> > 3) Where are the tutorials/documentation?
> Documentation
> > 4) How do I complain about a bug?
> Bugs
> > 5) Where do I ask a question?
> Mailing Lists
>
> > and then more minor questions like:
> >
> > 6) So who is behind Project X?
> Team Members
> > 7) What Apache community does Project X belong to?
> What's an Apache community? Do you mean 'top-level project'?
Nope. Like, Jakarta should point to the Apache front page somewhere, Ant
should too. BSF should point to Jakarta.
ie) Apache projects are a hierarchy. If the idea of a project being in
multiple communities occurs, then it would list these.
>
> [snippage]
> > Those who can't do, complain. But I'm happy to be a member of both sets.
> I
> > believe the first step is to actually try to cross-manage the site. Tbh,
> I
> What's cross-management?
Management's obviously a bad word, but I'm thinking of some form of
structure that Apache sites have to fit into. Like saying that every
subsite has to show the Apache logo etc. Basically trying to create a
site-contract that sub-projects agree to, hopefully helping to make the
site more usable to users without forcing anything too painful on
projects.
> > Once a site-wide contract for labelling and minimum functionality is
> > ironed out, each particular look and feel, project and generational tool
> > are free to enhance it as much as they want, as long as they:
> >
> > eg) Provide a link called 'Download nightly build' or whatever.
> Cool.
>
> Let's take a stab at it then.
Okay. I'd like to start a document, I guess Wiki would be a good choice
for this, and evolve the document. Wiki, Mailing list, jakarta-site2 cvs?
Hen
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@jakarta.apache.org
For additional commands, e-mail: general-help@jakarta.apache.org
Re: The Jakarta Site Was: [Discussion] (Fake)Forrest for Jakarta!
Posted by di...@multitask.com.au.
Henri Yandell <ba...@generationjava.com> wrote on 31/01/2003 02:28:59 PM:
[snip]
> However, a consistent skin might actually be the best way to get a
> consistently labelled and functional site together.
>
> Now I get to disagree with Dion :) His list of important things, the
ones
> Maven produce, are by and large not important. The important things are
> the ones the user cares about:
They're important to me as a developer. As a user, yeah it's a different
list.
How about we give these items some names:
> 1) Where do I download?
Downloads
> 2) Has their been a release?
Release Notes
> 3) Where are the tutorials/documentation?
Documentation
> 4) How do I complain about a bug?
Bugs
> 5) Where do I ask a question?
Mailing Lists
> and then more minor questions like:
>
> 6) So who is behind Project X?
Team Members
> 7) What Apache community does Project X belong to?
What's an Apache community? Do you mean 'top-level project'?
[snippage]
> Those who can't do, complain. But I'm happy to be a member of both sets.
I
> believe the first step is to actually try to cross-manage the site. Tbh,
I
What's cross-management?
> Once a site-wide contract for labelling and minimum functionality is
> ironed out, each particular look and feel, project and generational tool
> are free to enhance it as much as they want, as long as they:
>
> eg) Provide a link called 'Download nightly build' or whatever.
Cool.
Let's take a stab at it then.
--
dIon Gillard, Multitask Consulting
Blog: http://www.freeroller.net/page/dion/Weblog
Work: http://www.multitask.com.au
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@jakarta.apache.org
For additional commands, e-mail: general-help@jakarta.apache.org
Re: The Jakarta Site
Posted by Henri Yandell <ba...@generationjava.com>.
[I am inlining the document I have written. I tried to begin a little
formally, but it's all using personal habits of documentaton, so feel free
to be anarchic at it. I'm happy to Wiki it or put it in Jakarta-site2/
I will attempt to maintain change control on it based on comments until
such a time as it goes into one of the above]
***********************************************************************
@author: Henri Yandell <ba...@apache.org>
@creation: 2003/01/31
@state: proposal
@version: 0.1
Introduction
============
Purpose
-------
To create a low buy-in contract for ASF projects [or just ASF Jakarta projects] web
sites so as to provide a more coherent experience for users.
Scope
-----
The existing web sites are huge, and slowly losing coherency.
Parties
-------
Any Contributors, Committers, Members or Directors of the ASF.
Definition of terms
-------------------
ASF = Apache Software Foundation
References
----------
Standard of documentation: http://www.flamefew.com/~hen/HowToDocument.html
How to architect a site : http://www.generationjava.com/articles/web/infoArch.shtml
Over of the remainder of document
---------------------------------
The following is the application of the 10-point 'how to architect a site' plan
against the existing ASF web sites.
An Information Architecture for the ASF sites
=============================================
1 - Mission/Goals
The mission of the Apache website is to present the Apache Software Foundation and
its projects.
2 - Consumers
Members of the ASF, Committers and Contributers, will all use the site to present
their work and the ASF. Herewith known as the People of the ASF.
Existing users will use the site to discover documentation and cross-reference to
other projects. They will also use the site to discover how to communicate with
the People of the ASF.
New users will use the site to discover a project. They will want an introduction
to the project, and to be able to download the project.
3 - Content and functionality
The site's content is chiefly separated into two areas, the ASF and the projects
of the ASF. The ASF itself provides various corporate-style information pages. The
projects of the ASF are hierarchical in nature.
Each project contains the following:
*) Children projects.
*) The parent project.
*) Download of Nightly/Formal releases of Source/Binary.
*) Bug-reporting. [ie bugzilla]
*) Source control. [ie CVS]
*) People of the Project.
*) News. [ie) Official releases, announced bugs etc]
*) Status. [ie) The current state of the project. What's next, which version to use. known bugs list in important releases]
*) Mailing lists. How to join, unjoin, archives.
*) Date of creation of page/site
A project's site is mainly aimed at users, who may be People of another Project.
4 - Security
The site as described in this document is utterly open. Partly because the document
is being written by a user rather than an owner of the site. There are probably hidden
aspects of the site for maning mail-lists/archives/etc.
5 - Content Organisation
The structure of the content maps to the hierarchy of the Projects. It is possible that
Projects may form a graph and not a hierarchy, or even a set of graphs. Project sites
are expected to cross-link a lot. The existing site currently contains this hierarchy
and can be documented at a later date, or allowed to evolve naturally.
6 - Navigation
Again, the existing navigation structure will probably be used. A top-level horizontal
line will contain parent/currnet project display [ie via logo's etc]. The left column
will contain navigation structure for the project. The rest of the page contains the
content, which will contain many embedded ad-hoc links.
7 - Labelling
Project names are already chosen. Project logos need to be standardised as official
'labels' [mainly due to some projects using old logo's, ie Jakarta Taglibs].
Projects contain content with labels of:
[from Dion]
Downloads
Bugs
Status [Dion said Release Notes, I disagreed]
Mailing Lists
Team Members [I like 'People']
Documentation
News
Source-Control
Other pieces of content, such as parent/current projects and page/site creation timestamp
will be obvious without needing labels. Parent project are on the left of the top-bar,
current projects on the right.
8 - Search methods
Mail archives need to be searchable. Archives take care of this themselves.
The site needs to be searchable. [Should this search ability be on all pages??]
The source-control system is searchable via a viewcvs.cgi [or equivalent] view.
Projects will be found via the front page, in hierarchical nature.
Deep-linking occurs heavily, so urls are very persistent.
9 - Static vs Dynamic
Due to the high number of users to the website, dynamic pages are a performance issue.
The Bug system has to be dynamic.
Any possible online running examples should be available dynamically to view on the
site, but this probably needs bandwidth donation from the People of the ASF. For
example, I plan to setup a Tomcat server hosting the examples.war from every Jakarta
Taglib project and link it into the site as an example of each example running.
10 - Site expansion
The major growth positions for the ASF site are:
ASF: New projects added to the hierarchy all the time. Usually it is rare to add
new top-level projects, though currently this is in fashion. New projects also add the
resources needed by projects, source-control, mailing lists, bug-entries.
ASF News is also added constantly.
Projects:
People are added and are removed.
Releases occur.
Nightly builds happen each night, and it is assumed are removed in some fashion.
News is added.
Bugs are added.
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@jakarta.apache.org
For additional commands, e-mail: general-help@jakarta.apache.org