You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@forrest.apache.org by Ross Gardler <rg...@apache.org> on 2005/05/11 18:35:11 UTC

Who uses Forrest? (was Re: [RT] Directory structure and configuration)

Ferdinand Soethe wrote:
>>I think we should keep build/ as top-level because that is most common
>>in cocoon related projects. Everything that you now describe is part of
>>some kind of build.
> 
> 
> I will make this point one last time and then keep quiet about it.

I'd rather you didn't keep quiet. Your opinion is critical in this.

> This whole discussion was started because I wanted Forrest to become
> more transparent for new people beyond the sworn in community. And
> this goal is sometimes incompatible with making 'cocoonies' feel right
> at home.
> 
> But we/you need to make up our mind about that. And if you decide to
> stick to the technical naming we have now, we won't be able to explain
> structure to normal people (or train it) and so I'd start working on a
> gui interface that hides all this.

Who currently uses Forrest?
Who will Forrest be used by in the future?

and most importantly:

Who is Forrest aimed at?

I ask these questions because what Ferdinand is proposing relies on us 
being able to answer these questions. He is proposing considerable 
changes in the names of important files, directory structures and 
concepts in order to make Forrest more understandable for a, as yet, 
unidentified, end user.

Right now, in my view, Forrest does not want to attract end users that 
are not comfortable with XML, CSS, XSLT and Cocoon Pipelines. In my view 
we should be improving our docs from a *technical* perspective rather 
than a *user* perspective. We should be making it really easy for people 
to build new plugins and skins. We should be making it really easy for 
technical users to come along and enhance the Forrest application.

Changing our terminology to one that is not appropriate for technical 
users, most likely coming from a Cocoon background or from an XML/XSLT 
background, may have actually make it *harder* for the very users we are 
trying to attract (IMHO).

I do understand what Ferdinand is trying to do, and I agree that making 
Forrest more accessible to non-technical end users is very important. 
However, I'm not convinced the approach is correct.

I would prefer to see (non-technical) end users supported by a set of 
tools for configuring Forrest, preferably with a GUI interface, but at 
the very least by ant scripts that will ask the user questions and 
configure the system accordingly.

For example, doing 'forrest seed' should ask what the site name is, what 
skin should be used, what plugins will be required and so on. The end 
result will be a seed site that doesn't need customising through the 
editing of config files and so the (non-technical) user doesn't need to 
know anything about them. Consequently we can keep their locations and 
names familiar to the technical user.

I'm +1 on name changes that make it easier to document (non-technical) 
end-user interfaces to the application. But I'm -1 on changing things 
that the (non-technical) user should have no need to see. I'd rather see 
the effort go into writing helper applications/scripts that hide the 
complexities of Forrest from such users whilst still keeping the 
underlying design familiar to out technical users.

Writing Ant scripts is surprisingly easy once there are a set of 
examples to follow. Perhaps effort should be put into user focused 
scripts rather than complex name changes that will resonate through all 
our existing code and documentation.

Ross

Re: Who uses Forrest? (was Re: [RT] Directory structure and configuration)

Posted by Ross Gardler <rg...@apache.org>.
Ferdinand Soethe wrote:
> Ross wrote
> 
> 
>>>I will make this point one last time and then keep quiet about it.
>>
>>I'd rather you didn't keep quiet. Your opinion is critical in this.
> 
> 
> OK, since you asked for it :-)
> 
> 1. End users
> 

...

> So why not make it easier for these people (and win broader support) as
> long as it doesn't mean making compromises on quality.

I'm all for making it easier, but I disagree with *how* it is made 
easier. I would prefer it if an end-user could pick up forrest and build 
a simple, standard site *without* looking at *any* docs other than a 3 
line install and run description.

To achieve this we need helper tools, not different documentation (of 
course, it is not as clearly separated as this, *some* documentation 
will always be needed for the end-user).

> 2. Technical users
> 
> I question the fact that Forrest is currently easy
> to understand for technical users. I think it is only easy to
> understand for people with a cocoon background!

Without an understanding of Cocoon pipelines, generators, transformers, 
serialisers, matchers, etc. etc. they won't get very far in Forrest. It 
is possible to do some skin customisation without Cocoon knowledge, but 
you can't do anything else. If you can find a way around this then that 
is great.

Sure, (non-technical) end-users have been empowered by the plugins, but 
why bother explaining to them how to configure forrest.properties, or 
forrest.xml or forrest.conf.xml or whatever we name it. Wouldn't it be 
better to have a script or gui that said "this plugin does XYZ, do you 
wnat to use it?" Then they don't care what the file is called.

> 3. GUI

...

> However I would really like working towards making Forrest a system
> where non-technical power users have a chance to throw away their
> gui-crutches at some point and work with the whole flexibility of
> Forrest below.

This blurs the distinction between non-technical end-users and technical 
users. What is a "power" user? How do we define one? What will they be 
doing with Forrest?

If they simply want to configure the way Forrest works by employing 
verious plugins and perhaps configuring their skin then a set of 
scripts/guis are what are need, coupled with clear documentation about 
the skinning system.

If they want to make Forrest do something that it can't already do they 
will have to learn about the Cocoon way of doing things because Forrest 
is a Cocoon app. That makes them a technical user - or at least someone 
willing to become a technical user. They will then need to read Cocoon 
docs as well as our own.

---

I am still +1 on anything that makes it easier for end-users. This 
includes, but is not limited to, renaming build targets to enable 
clearer docs to be written, or (preferably) building helper scripts that 
remove the need for the end-user to know the target names. These scipts 
can then be written from the perspective of an end user and the 
underlying framework can stick with the terminology used by the devs. 
Furthermore these scripts can be used in the Eclipse plugin (which, 
incidentally, already has a basic wizard for creating a new site).

I'm still -1 on changing the names of the configu files etc. we need to 
stay close to the nearest thing we have to "standards", that is we need 
to see the underlying structure of Forrest continuing to look like a 
Cocoon application. I pick on "a Cocoon appication" as our standard 
because that is what Forrest is, and very often we find ourselves 
referring technical users to Cocoon docs. It would therefore make sense 
for files to be named the same and located in the same locations as 
documented in those docs.

> P.S.
> 
> All this does not mean that all the changes I suggested serve that
> goal. That I'm happy to discuss and question any time.

Yes, I'll return to those threads when we are agreed on who we are 
targetting and what our aims in the resturcuting is.

Ross

Re: Who uses Forrest? (was Re: [RT] Directory structure and configuration)

Posted by Ferdinand Soethe <sa...@soethe.net>.
Ross wrote

>> I will make this point one last time and then keep quiet about it.
> 
> I'd rather you didn't keep quiet. Your opinion is critical in this.

OK, since you asked for it :-)

1. End users

I agree that there are limits in what we can do to make
end users understand Forrest.

Pls. note however that Forrest is close enough to a system that can
be used out of the box and it will attract end users. And searching
the German web for Forrest sites I found a number of sites that were
certainly not build by Cocoonies.

So why not make it easier for these people (and win broader support) as
long as it doesn't mean making compromises on quality.

2. Technical users

I question the fact that Forrest is currently easy
to understand for technical users. I think it is only easy to
understand for people with a cocoon background!

But I'm convinced that the majority of people that could/will use
Forrest in the future will NOT have that background. In fact many
won't even have the unix/linux or java/web applications-background
that helps understand many terms.

3. GUI

You know that I like to have a GUI for Forrest because I would make it
much easier to convince people in the beginning.

However I would really like working towards making Forrest a system
where non-technical power users have a chance to throw away their
gui-crutches at some point and work with the whole flexibility of
Forrest below.

Which is a good reason to have a GUI AND make the system easier to
understand,

don't you think.

Ferdinand


P.S.

All this does not mean that all the changes I suggested serve that
goal. That I'm happy to discuss and question any time.