forrest-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Crossley <cross...@apache.org>
Subject Re: [jira] Updated: (FOR-639) define terminology for the various aspects of Dispatcher
Date Fri, 31 Mar 2006 22:41:44 GMT
Gav.... wrote:
> Ok, Paul has also mentioned this so needs sorting, I'll see what I can come
> up with in the next day or two.
> 
> What we have so far it terms of Dispatcher Docs published:-
> 
> dispatcher.html
> howto-structurer-install.html
> howto-dispatcher-quickstart.html
> howto-structurer-dsl.html
> howto-structurer-contracts.html
> 
> The howto-structurer-install.html is actually describing how to 
> Install the "Dispatcher" so I think should be renamed to avoid
> Further confusion.

Yes, i have wondered about that too.
Today i will 'svn move' the documents,
amend all the links and references, and
create .htaccess redirects for the website.

> The howto-structurer-dsl is out of date and contains incorrect
> Contract examples. Is there an upto date version of this or
> Shall I attempt to correct the examples given.
> 	Also, I would like an example of what is meant by
> "Domain Specific" in this context  (of -dsl)
> 
> This FOR is about clarifying and defining terminology used. So do we
> Want a new page called dispatcher-terminology.html or similar and how
> Do we want the content presented - in example form, or in a strict
> Dictionary type arrangement leaving the examples on the howto pages?

There was a mailing list discussion about this.
Need to find that.

One really good idea was to create the new Glossary plugin
http://issues.apache.org/jira/browse/FOR-755
and use that.

Failing that, i reckon just use an ordinary document
with concise definitions that link to examples in
the other documents.

However it gets done is good.

-David

> The terminology can have brief paragraph descriptions and links to 
> Examples in the howto pages.
> 
> I expect a line-drawing hierarchy linking the terminology into their
> Repective positions would be handy.
> 
> Any other ideas ?
> 
> Paul, what are you not clear on that needs expanding on?
> 
> Gav...

Mime
View raw message