You are viewing a plain text version of this content. The canonical link for it is here.
Posted to phoenix-dev@avalon.apache.org by David Weitzman <da...@optonline.net> on 2002/09/11 00:13:37 UTC
Documentation stuff
The general presentation and organization of the phoenix guide could use
some refactoring and focus. I think a single extended example would be more
useful than the non-linearly ordered collection of seperate topics that
currently exists. The flow of application creation might be better
expressed by showing the development of an application through each of the
stages in order:
Block development -> Assembly -> Deploy -> Simple Administration (start and
stop) -> go back and add JMX support to the block -> Administration through
JMX.
Making the example downloadable would be friendly, but then you begin to
cross over with the avalon-apps stuff. Maybe also a downloadable template
project (ant, empty block, empty config files).
Also:
In the admin docs I forgot to mention the xdoclet stuff for exposing MBeans
to Phoenix. Plus there's already a Management Guide. There shouldn't be
more than one version of the JMX information.
Also:
index.xml links to guide-administrators.html when it should like to
guide-administrator.html
Also:
Perhaps provide for developers brief overviews of all the stuff in the
phoenix.interfaces package.
Now I must go fill out forms :(
David Weitzman
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Documentation stuff
Posted by David Weitzman <da...@optonline.net>.
Peter Donald wrote:
> On Thu, 12 Sep 2002 19:36, Peter Donald wrote:
> > When I did this I created the "Stailze" server. Essentially this server
> > accepted connections from network, the client sent a java source file,
the
> > server formatted the source file and sent it back to the client. I used
> > JRefactory (jrefactory.sourceforge.net) to do formatting.
>
> Some other links include;
>
> http://Recoder.sourceforge.net/ (neat!)
> http://Jalopy.sourceforge.net/index.html
Great idea. I'll try to start writing something next week.
David Weitzman
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Documentation stuff
Posted by Peter Donald <pe...@apache.org>.
On Thu, 12 Sep 2002 19:36, Peter Donald wrote:
> When I did this I created the "Stailze" server. Essentially this server
> accepted connections from network, the client sent a java source file, the
> server formatted the source file and sent it back to the client. I used
> JRefactory (jrefactory.sourceforge.net) to do formatting.
Some other links include;
http://Recoder.sourceforge.net/ (neat!)
http://Jalopy.sourceforge.net/index.html
--
Cheers,
Peter Donald
-----------------------------------------------
"You can't depend on your eyes when your
imagination is out of focus." -Mark Twain
-----------------------------------------------
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Documentation stuff
Posted by Peter Donald <pe...@apache.org>.
Hi,
On Thu, 12 Sep 2002 09:05, David Weitzman wrote:
> Any ideas for an example? Since Phoenix is targeted at the server
> environment, something that involves the cornerstone connection manager
> might be appropriate. What about a really simple HTTP server?
It is up to you. Basically whatever you find interesting. I would recomend
against a HTTP server given the large number of those around the place.
When I did this I created the "Stailze" server. Essentially this server
accepted connections from network, the client sent a java source file, the
server formatted the source file and sent it back to the client. I used
JRefactory (jrefactory.sourceforge.net) to do formatting.
I wrote it up as several chapters starting from basics and going through each
step in the process. The outline went something like
Chapter 1: How to create an App
Hello World Block (Basics of application and has a block that just printed
"Hello World").
Chapter 2: How to use Dependencies
Use ConnectionManager Block to accept connections from network and do basic
formatting of Java Source Code.
Chapter 3: How to write a Service
Extract a SourceCodeFormatter service and have the main Block depend upon it
and use it to format code extracted from network
Chapter 4: The Environment
How to configure loggers so that they print out to console, files, and to
unix syslog. How to set up security policy that application operates under.
Chapter 5: Managing your Application
Essentially this was how to make your blocks manageable.
etc.
That was a useful structure for me to write to. The actual server part was
pretty minimal ;) However I would recomend that you write something that is
useful or "neat". A SourceCode formatting server was kinda neat. If you no
like that then there is plenty of other neat ideas running around.
--
Cheers,
Peter Donald
--------------------------------------------------
Logic: The art of being wrong with confidence...
--------------------------------------------------
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Documentation stuff
Posted by David Weitzman <da...@optonline.net>.
Peter Donald wrote:
> On Wed, 11 Sep 2002 08:13, David Weitzman wrote:
> > I think a single extended example would be
> > more useful than the non-linearly ordered collection of seperate topics
> > that currently exists. The flow of application creation might be better
> > expressed by showing the development of an application through each of
the
> > stages in order:
> >
> > Block development -> Assembly -> Deploy -> Simple Administration (start
and
> > stop) -> go back and add JMX support to the block -> Administration
through
> > JMX.
>
> That would be fantastic. I started this in the past but have never been
able
> to get it down on the computer. I actually have about 90 pages of
doublsided
> A4 written up for just this but I have had them sitting in the corner for
> over a year ;(
>
> If you could make a start on this it would be great !
Any ideas for an example? Since Phoenix is targeted at the server
environment, something that involves the cornerstone connection manager
might be appropriate. What about a really simple HTTP server?
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Documentation stuff
Posted by Peter Donald <pe...@apache.org>.
On Wed, 11 Sep 2002 08:13, David Weitzman wrote:
> The general presentation and organization of the phoenix guide could use
> some refactoring and focus.
I agree. I actually got that complain twice last week ;) Some people
recomended we break it down similar to how Tomcat does it. ie Have HOWTOs for
each major feature. I think we would still need to separate between developer
HOWTOs and Admin HOWTOs but it could work.
> I think a single extended example would be
> more useful than the non-linearly ordered collection of seperate topics
> that currently exists. The flow of application creation might be better
> expressed by showing the development of an application through each of the
> stages in order:
>
> Block development -> Assembly -> Deploy -> Simple Administration (start and
> stop) -> go back and add JMX support to the block -> Administration through
> JMX.
That would be fantastic. I started this in the past but have never been able
to get it down on the computer. I actually have about 90 pages of doublsided
A4 written up for just this but I have had them sitting in the corner for
over a year ;(
If you could make a start on this it would be great !
> Making the example downloadable would be friendly, but then you begin to
> cross over with the avalon-apps stuff. Maybe also a downloadable template
> project (ant, empty block, empty config files).
> Also:
>
> In the admin docs I forgot to mention the xdoclet stuff for exposing MBeans
> to Phoenix. Plus there's already a Management Guide. There shouldn't be
> more than one version of the JMX information.
right ;)
> Also:
>
> index.xml links to guide-administrators.html when it should like to
> guide-administrator.html
this has been fixed in the release branch.
> Also:
>
> Perhaps provide for developers brief overviews of all the stuff in the
> phoenix.interfaces package.
Yep. We should probably javadoc these better and add more to package.html
> Now I must go fill out forms :(
:/
--
Cheers,
Peter Donald
-----------------------------------------------------------
Don't take life too seriously --
you'll never get out of it alive.
-----------------------------------------------------------
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [PATCH] Re: [PATCH] Re: Documentation stuff
Posted by Peter Donald <pe...@apache.org>.
On Sat, 14 Sep 2002 13:43, David Weitzman wrote:
> Supreme stupidity. That was copy and paste nonsense. The jmx xdoclet tag
> is for the SMTP stuff I'm working on. Scratch that. Here's a fixed patch.
>
> David Weitzman
Applied again ;)
--
Cheers,
Peter Donald
-----------------------------------------------
| If you turn on the light quickly enough, |
| you can see what the dark looks like. |
-----------------------------------------------
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
[PATCH] Re: [PATCH] Re: Documentation stuff
Posted by David Weitzman <da...@optonline.net>.
Supreme stupidity. That was copy and paste nonsense. The jmx xdoclet tag
is for the SMTP stuff I'm working on. Scratch that. Here's a fixed patch.
David Weitzman
Re: [PATCH] Re: Documentation stuff
Posted by Peter Donald <pe...@apache.org>.
On Sat, 14 Sep 2002 13:25, David Weitzman wrote:
> David Weitzman wrote:
> > In the admin docs I forgot to mention the xdoclet stuff for exposing
>
> MBeans
>
> > to Phoenix. Plus there's already a Management Guide. There shouldn't be
> > more than one version of the JMX information.
>
> One more TODO that links to the other JMX info and the necessary xdoclet
> parameter. For the release, I want to at least cover myself ;)
applied ;)
--
Cheers,
Peter Donald
*------------------------------------------------------*
| "Common sense is the collection of prejudices |
| acquired by age 18. " -Albert Einstein |
*------------------------------------------------------*
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
[PATCH] Re: Documentation stuff
Posted by David Weitzman <da...@optonline.net>.
David Weitzman wrote:
> In the admin docs I forgot to mention the xdoclet stuff for exposing
MBeans
> to Phoenix. Plus there's already a Management Guide. There shouldn't be
> more than one version of the JMX information.
One more TODO that links to the other JMX info and the necessary xdoclet
parameter. For the release, I want to at least cover myself ;)
David Weitzman
Re: Documentation stuff
Posted by Paul Hammant <Pa...@yahoo.com>.
David ,
You are quite right. I'll try to ake a page or two as outlined, but
maybe not for this release.
- Paul
>The general presentation and organization of the phoenix guide could use
>some refactoring and focus. I think a single extended example would be more
>useful than the non-linearly ordered collection of seperate topics that
>currently exists. The flow of application creation might be better
>expressed by showing the development of an application through each of the
>stages in order:
>
>Block development -> Assembly -> Deploy -> Simple Administration (start and
>stop) -> go back and add JMX support to the block -> Administration through
>JMX.
>
>Making the example downloadable would be friendly, but then you begin to
>cross over with the avalon-apps stuff. Maybe also a downloadable template
>project (ant, empty block, empty config files).
>
>Also:
>
>In the admin docs I forgot to mention the xdoclet stuff for exposing MBeans
>to Phoenix. Plus there's already a Management Guide. There shouldn't be
>more than one version of the JMX information.
>
>Also:
>
>index.xml links to guide-administrators.html when it should like to
>guide-administrator.html
>
>Also:
>
>Perhaps provide for developers brief overviews of all the stuff in the
>phoenix.interfaces package.
>
>Now I must go fill out forms :(
>
>David Weitzman
>
>
>--
>To unsubscribe, e-mail: <ma...@jakarta.apache.org>
>For additional commands, e-mail: <ma...@jakarta.apache.org>
>
>
>
>
>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: Documentation stuff
Posted by Leo Simons <le...@apache.org>.
+1. It's just someone has to do it :)
- Leo
On Wed, 2002-09-11 at 00:13, David Weitzman wrote:
> The general presentation and organization of the phoenix guide could use
> some refactoring and focus.
<snip good ideas/>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>