Re: GShell Goals

[Hernan Cunico]

As just a personal preference, I would keep some overview on the Geronimo web 
site and then have the gross of the documentation on the wiki. I mean that in 
the way it looks, I know it is all generated from the wiki. For example, 
compare geronimo.a.o with cwiki.a.o/geronimo. Web site and documentation should 
definitively be on separate spaces for administration purposes.

I guess it ultimately will depend on how much of Geronimo GShell is going to 
be. The more important/relevant/dependent the more we need to have it as part 
of G doc. With that I don't mean that GShell should not have it's own separate 
wiki, I mean that if it is separate we need to include as much Geronimo 
specific info as possible. I hope that the more dependent the more alike with 
Geronimo documentation structure. ;-)

More on personal preference, for documentation I wouldn't use the same template 
used for the web site. I rather stay as far away as possible from the classic 
wiki look and feel on the web site.

Do you have any of these already covered?

   * what is it?
   * benefits
   * what it does
   * what it replaces (if replaces anything)
   * tools and commands
   * how-to samples and tutorials


Cheers!
Hernan

Jason Dillon wrote:
Yup, we defs need to add more docs... though atm I'm at a loss as to how 
to organize things on the site.  Any ideas?  I had been kinda following 
how ActiveMQ's site is laid out.


Got a list of items which you feel must be documented?

--jason


On Jan 31, 2008, at 7:14 AM, Jason Warner wrote:


Hey Jason,

What I saw looks nifty.  I like where Gshell is going.  One thing that 
I didn't see on there, and that might be because you are already 
working on it, is user docs.  I think that Gshell is fairly intuitive 
and easy to use, but there are a couple things that I didn't get 
without bugging you a bit.  Descriptions of how commands and paths 
work might be useful as well as just a heads up about where and how to 
use gshell.profile.  I'm sure there's other things that could go into 
a user doc.  This might even be worth throwing together real quick so 
that Hernan can have something for his 2.1 docs? 

Also, I don't have the ability to edit those pages, but I'd be happy 
to help with any documentation work.


~Jason Warner

On Jan 31, 2008 4:19 AM, Jason Dillon <[EMAIL PROTECTED] 
> wrote:


Just a quick note... I'm starting to fix up the GShell site more...
and added a new page for the upcoming/ongoing goals here:

http://cwiki.apache.org/GSHELL/goals.html

Please have a look, add, comment whatever.

Thanks,

--jason

Re: GShell Goals

[Jason Dillon]

Yup, we defs need to add more docs... though atm I'm at a loss as to  
how to organize things on the site.  Any ideas?  I had been kinda  
following how ActiveMQ's site is laid out.


Got a list of items which you feel must be documented?

--jason


On Jan 31, 2008, at 7:14 AM, Jason Warner wrote:


Hey Jason,

What I saw looks nifty.  I like where Gshell is going.  One thing  
that I didn't see on there, and that might be because you are  
already working on it, is user docs.  I think that Gshell is fairly  
intuitive and easy to use, but there are a couple things that I  
didn't get without bugging you a bit.  Descriptions of how commands  
and paths work might be useful as well as just a heads up about  
where and how to use gshell.profile.  I'm sure there's other things  
that could go into a user doc.  This might even be worth throwing  
together real quick so that Hernan can have something for his 2.1  
docs?


Also, I don't have the ability to edit those pages, but I'd be happy  
to help with any documentation work.


~Jason Warner

On Jan 31, 2008 4:19 AM, Jason Dillon <[EMAIL PROTECTED]> wrote:
Just a quick note... I'm starting to fix up the GShell site more...
and added a new page for the upcoming/ongoing goals here:

http://cwiki.apache.org/GSHELL/goals.html

Please have a look, add, comment whatever.

Thanks,

--jason

Re: GShell Goals

[Jason Warner]

Hey Jason,

What I saw looks nifty.  I like where Gshell is going.  One thing that I
didn't see on there, and that might be because you are already working on
it, is user docs.  I think that Gshell is fairly intuitive and easy to use,
but there are a couple things that I didn't get without bugging you a bit.
Descriptions of how commands and paths work might be useful as well as just
a heads up about where and how to use gshell.profile.  I'm sure there's
other things that could go into a user doc.  This might even be worth
throwing together real quick so that Hernan can have something for his
2.1docs?

Also, I don't have the ability to edit those pages, but I'd be happy to help
with any documentation work.

~Jason Warner

On Jan 31, 2008 4:19 AM, Jason Dillon <[EMAIL PROTECTED]> wrote:

> Just a quick note... I'm starting to fix up the GShell site more...
> and added a new page for the upcoming/ongoing goals here:
>
> http://cwiki.apache.org/GSHELL/goals.html
>
> Please have a look, add, comment whatever.
>
> Thanks,
>
> --jason
>

GShell Goals

[Jason Dillon]

Just a quick note... I'm starting to fix up the GShell site more...  
and added a new page for the upcoming/ongoing goals here:


http://cwiki.apache.org/GSHELL/goals.html

Please have a look, add, comment whatever.

Thanks,

--jason