First Draft Grails Reference Docs

[Graeme Rocher-2]

Hi All,

I've put up the first draft of the official Grails reference docs.
Could those of you interested please read through and email back in
this thread any mistakes or suggestions you find.

http://grails.org/doc/RC1/

Look forward to the feedback.

Cheers

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[dellsoft]

Good work

thanks very much

Graeme Rocher-2 wrote:

Hi All,

I've put up the first draft of the official Grails reference docs.
Could those of you interested please read through and email back in
this thread any mistakes or suggestions you find.

http://grails.org/doc/RC1/

Look forward to the feedback.

Cheers

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Jean-Noël Rivasseau-3]

This is excellent news!

Nice job, Graeme and Marc.

Random remarks/complaints:

Firefox is very slow on the page due to the fact that everything is on a single document (if on the frames version: the no frmaes is OK).

I like the reference at the bottom left. I wish there would be a table of contents at the top left though.

I did not read the documentation yet, just skimmed over the Hibernate section. This one could be improved. For example there is no mention of the fact that you can map a POGO with Hibernate, and not only a POJO.

Jean-Noel

On Nov 12, 2007 1:11 PM, Graeme Rocher <graeme@...> wrote:

Hi All,

I've put up the first draft of the official Grails reference docs.
Could those of you interested please read through and email back in
this thread any mistakes or suggestions you find.

http://grails.org/doc/RC1/

Look forward to the feedback.

Cheers

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[justinedelson]

It looks like all of the links in the nav under Servlet API (i.e. request, resposne, servletContext, session) load blank pages.

On Nov 12, 2007 7:11 AM, Graeme Rocher <graeme@...> wrote:

Hi All,

I've put up the first draft of the official Grails reference docs.
Could those of you interested please read through and email back in
this thread any mistakes or suggestions you find.

http://grails.org/doc/RC1/

Look forward to the feedback.

Cheers

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

   http://xircles.codehaus.org/manage_email

[Graeme Rocher-2]

Yes that bit is not quite finished.

Cheers

On Nov 12, 2007 12:28 PM, Justin Edelson <justin@...> wrote:

> It looks like all of the links in the nav under Servlet API (i.e. request,
> resposne, servletContext, session) load blank pages.
>
>
>
> On Nov 12, 2007 7:11 AM, Graeme Rocher < graeme@...> wrote:
> >
> >
> >
> > Hi All,
> >
> > I've put up the first draft of the official Grails reference docs.
> > Could those of you interested please read through and email back in
> > this thread any mistakes or suggestions you find.
> >
> > http://grails.org/doc/RC1/
> >
> > Look forward to the feedback.
> >
> > Cheers
> >
> > --
> > Graeme Rocher
> > Grails Project Lead
> > G2One, Inc. Chief Technology Officer
> > http://www.g2one.com
> >
> > ---------------------------------------------------------------------
> >
> > To unsubscribe from this list please visit:
> >
> >    http://xircles.codehaus.org/manage_email
> >
> >
>
>

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Nacho Brito Calahorro]

Guys, this seems like a HUGE effort you're doing. Great job!

Graeme Rocher escribió:

Yes that bit is not quite finished.

Cheers

On Nov 12, 2007 12:28 PM, Justin Edelson justin@... wrote:
  

It looks like all of the links in the nav under Servlet API (i.e. request,
resposne, servletContext, session) load blank pages.



On Nov 12, 2007 7:11 AM, Graeme Rocher < graeme@...> wrote:
    

Hi All,

I've put up the first draft of the official Grails reference docs.
Could those of you interested please read through and email back in
this thread any mistakes or suggestions you find.

http://grails.org/doc/RC1/

Look forward to the feedback.

Cheers

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------

To unsubscribe from this list please visit:

   http://xircles.codehaus.org/manage_email


      

[Graeme Rocher-2]

On Nov 12, 2007 12:27 PM, Jean-Noël Rivasseau <elvanor@...> wrote:
> This is excellent news!
>
> Nice job, Graeme and Marc.
>
> Random remarks/complaints:
>
> Firefox is very slow on the page due to the fact that everything is on a
> single document (if on the frames version: the no frmaes is OK).

There is a multipage version too, the singe page is just the default.

>
> I like the reference at the bottom left. I wish there would be a table of
> contents at the top left though.

We could split out the user guide and the reference completely if
people are happier with that.

>
> I did not read the documentation yet, just skimmed over the Hibernate
> section. This one could be improved. For example there is no mention of the
> fact that you can map a POGO with Hibernate, and not only a POJO.

Yeh that probably could be improved a bit. If you have particular
areas you want documented please raise JIRA issues.

Cheers

>
> Jean-Noel
>
>
>
> On Nov 12, 2007 1:11 PM, Graeme Rocher <graeme@...> wrote:
> >
> >
> >
> > Hi All,
> >
> > I've put up the first draft of the official Grails reference docs.
> > Could those of you interested please read through and email back in
> > this thread any mistakes or suggestions you find.
> >
> > http://grails.org/doc/RC1/
> >
> > Look forward to the feedback.
> >
> > Cheers
> >
> > --
> > Graeme Rocher
> > Grails Project Lead
> > G2One, Inc. Chief Technology Officer
> > http://www.g2one.com
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe from this list please visit:
> >
> >     http://xircles.codehaus.org/manage_email
> >
> >
>
>

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Darren Davison]

On Mon, Nov 12, 2007 at 12:11:31PM +0000, Graeme Rocher wrote:
> I've put up the first draft of the official Grails reference docs.
> Could those of you interested please read through and email back in
> this thread any mistakes or suggestions you find.

I've not read this in much detail but I've looked at the structure and
format and skimmed a few of the sections.

While I imagine there are issues with the content (completeness or
accuracy) I think this is *exactly* the kind of thing grails needed and
the effort will be greatly appreciated by existing, but particularly new
users of the framework.

What's the process for supplying doc updates and suggestions? (I'm kind
of hoping this is not available for wiki users and that patches will
need to be sent to Jira for a documentation module).  With a way for the
community to contribute without sacrificing control of format or
content, it should be a recipe for success.

Great start guys, commendations and thanks :)


--
Darren Davison
Public Key: 0xE855B3EA

[Darryl Pentz]

Yeah, I agree. Excellent first step in the right direction regarding documentation.

Haven't mulled over it enough to give any critique yet, but first off, great job! No wonder the forum has been so quiet from you lot. ;-)

- DP

Nacho Brito Calahorro wrote:

Guys, this seems like a HUGE effort you're doing. Great job!

Graeme Rocher escribió:
> Yes that bit is not quite finished.
>
> Cheers
>
> On Nov 12, 2007 12:28 PM, Justin Edelson <[e-mail]> wrote:
>  
>> It looks like all of the links in the nav under Servlet API (i.e. request,
>> resposne, servletContext, session) load blank pages.
>>
>>
>>
>> On Nov 12, 2007 7:11 AM, Graeme Rocher < [e-mail]> wrote:
>>    
>>>
>>> Hi All,
>>>
>>> I've put up the first draft of the official Grails reference docs.
>>> Could those of you interested please read through and email back in
>>> this thread any mistakes or suggestions you find.
>>>
>>> http://grails.org/doc/RC1/
>>>
>>> Look forward to the feedback.
>>>
>>> Cheers
>>>
>>> --
>>> Graeme Rocher
>>> Grails Project Lead
>>> G2One, Inc. Chief Technology Officer
>>> http://www.g2one.com
>>>
>>> ---------------------------------------------------------------------
>>>
>>> To unsubscribe from this list please visit:
>>>
>>>    http://xircles.codehaus.org/manage_email
>>>
>>>
>>>      
>>    
>
>
>
>  

[chanwit]

Hi Graeme,

This is the exactly what people, at least in Thai Grails user group,
are asking about. They are getting convinced to start developing with
Grails ;-).

What about the document license? Do I have a proper right for translating it?

Cheers,

Chanwit

On 12/11/2007, Graeme Rocher <graeme@...> wrote:

> Hi All,
>
> I've put up the first draft of the official Grails reference docs.
> Could those of you interested please read through and email back in
> this thread any mistakes or suggestions you find.
>
> http://grails.org/doc/RC1/
>
> Look forward to the feedback.
>
> Cheers
>
> --
> Graeme Rocher
> Grails Project Lead
> G2One, Inc. Chief Technology Officer
> http://www.g2one.com
>
> ---------------------------------------------------------------------
> To unsubscribe from this list please visit:
>
>     http://xircles.codehaus.org/manage_email
>
>

--
Chanwit Kaewkasi
PhD Student,
Centre for Novel Computing
School of Computer Science
The University of Manchester
Oxford Road
Manchester
M13 9PL, UK

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Graeme Rocher-2]

On Nov 12, 2007 12:49 PM, Darren Davison <darren@...> wrote:

> On Mon, Nov 12, 2007 at 12:11:31PM +0000, Graeme Rocher wrote:
> > I've put up the first draft of the official Grails reference docs.
> > Could those of you interested please read through and email back in
> > this thread any mistakes or suggestions you find.
>
> I've not read this in much detail but I've looked at the structure and
> format and skimmed a few of the sections.
>
> While I imagine there are issues with the content (completeness or
> accuracy) I think this is *exactly* the kind of thing grails needed and
> the effort will be greatly appreciated by existing, but particularly new
> users of the framework.
>
> What's the process for supplying doc updates and suggestions? (I'm kind
> of hoping this is not available for wiki users and that patches will
> need to be sent to Jira for a documentation module).  With a way for the
> community to contribute without sacrificing control of format or
> content, it should be a recipe for success.

It isn't available via a wiki. It will be versioned with each release
(hence avoiding the need to have features marked as "since x.x" ) and
patches are welcomed via JIRA

The source code for the documentation can be found here:

http://svn.grails.codehaus.org/grails/trunk/grails-doc/

It uses the radeox engine for the templates hence is similar to
confluence mark-up so it should be easy for people to pick up. If you
want to build the docs checkout Grails and set GRAILS_HOME

svn co http://svn.codehaus.org/grails/trunk/grails-doc/

Then just run "ant" from the root of the grails-doc directory

Cheers

>
> Great start guys, commendations and thanks :)
>
>
> --
> Darren Davison
> Public Key: 0xE855B3EA
>
> -----BEGIN PGP SIGNATURE-----
> Version: GnuPG v1.4.6 (GNU/Linux)
>
> iD4DBQFHOEvdVgOfSOhVs+oRAphPAKC4JaIUvm19+Eh2+z8fe+HbNEUpIwCWNPXE
> H0d9F4rqgDgiOhWdvJ6eEw==
> =LHjl
> -----END PGP SIGNATURE-----
>
>

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Graeme Rocher-2]

On Nov 12, 2007 1:21 PM, Chanwit Kaewkasi <chanwit@...> wrote:
> Hi Graeme,
>
> This is the exactly what people, at least in Thai Grails user group,
> are asking about. They are getting convinced to start developing with
> Grails ;-).
>
> What about the document license? Do I have a proper right for translating it?


You're most welcome, so long as you acknowledge the source. Also,
preferably, translate it without changing the content, or indicate
clearly which material is taken from the original, and which is new.

Cheers

>
> Cheers,
>
> Chanwit
>
>
> On 12/11/2007, Graeme Rocher <graeme@...> wrote:
> > Hi All,
> >
> > I've put up the first draft of the official Grails reference docs.
> > Could those of you interested please read through and email back in
> > this thread any mistakes or suggestions you find.
> >
> > http://grails.org/doc/RC1/
> >
> > Look forward to the feedback.
> >
> > Cheers
> >
> > --
> > Graeme Rocher
> > Grails Project Lead
> > G2One, Inc. Chief Technology Officer
> > http://www.g2one.com
> >
> > ---------------------------------------------------------------------
> > To unsubscribe from this list please visit:
> >
> >     http://xircles.codehaus.org/manage_email
> >
> >
>
>
> --
> Chanwit Kaewkasi
> PhD Student,
> Centre for Novel Computing
> School of Computer Science
> The University of Manchester
> Oxford Road
> Manchester
> M13 9PL, UK
>
>
> ---------------------------------------------------------------------
> To unsubscribe from this list please visit:
>
>     http://xircles.codehaus.org/manage_email
>
>

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Randall Schulz]

On Monday 12 November 2007 04:11, Graeme Rocher wrote:
> Hi All,
>
> I've put up the first draft of the official Grails reference docs.
> Could those of you interested please read through and email back in
> this thread any mistakes or suggestions you find.

Hurrah!


> http://grails.org/doc/RC1/
>
> Look forward to the feedback.

To quote Homer Simpson, "Keep it comin'!"


One thing I will say is that documentation that is primarily based on
examples, as this seems to be, is not really a reference document.
Examples require readers to infer the general form of a thing (an
inductive and error-prone process).

What's needed in a reference manual is an exhaustive and generalized
enumeration of the system's entities (classes, builders, methods, tags,
etc.) along with a similarly comprehensive list of all the constituents
(properties, methods, parameters, tag attributes etc.) of those
entities. Furthermore things like allowable values (for properties,
actual method parameters or tag attributes, e.g.), invocation protocols
or allowed tag nesting must be described, as well.

Think "design by contract" and then, in (language-) lawyerly fashion,
specify those contracts.


Nonetheless, this is a good start. I hope to see it move towards a more
formal presentation over time.


> Cheers


Randall Schulz

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Daniel Kimmig]

AWESOME !!!

Exactly what you need for a 1.0 release!


Congratulations on that work!

Graeme Rocher-2 wrote:

Hi All,

I've put up the first draft of the official Grails reference docs.
Could those of you interested please read through and email back in
this thread any mistakes or suggestions you find.

http://grails.org/doc/RC1/

Look forward to the feedback.

Cheers

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Matt Chisholm-3]

Great work!

On Nov 12, 2007, at 11:29 AM, Daniel Kimmig wrote:

>
>
> AWESOME !!!
>
> Exactly what you need for a 1.0 release!
>
>
> Congratulations on that work!
>
>
> Graeme Rocher-2 wrote:
>>
>> Hi All,
>>
>> I've put up the first draft of the official Grails reference docs.
>> Could those of you interested please read through and email back in
>> this thread any mistakes or suggestions you find.
>>
>> http://grails.org/doc/RC1/
>>
>> Look forward to the feedback.
>>
>> Cheers
>>
>> --  
>> Graeme Rocher
>> Grails Project Lead
>> G2One, Inc. Chief Technology Officer
>> http://www.g2one.com
>>
>> ---------------------------------------------------------------------
>> To unsubscribe from this list please visit:
>>
>>     http://xircles.codehaus.org/manage_email
>>
>>
>>
>
> --  
> View this message in context: http://www.nabble.com/First-Draft- 
> Grails-Reference-Docs-tf4790665.html#a13708612
> Sent from the grails - user mailing list archive at Nabble.com.
>
>
> ---------------------------------------------------------------------
> To unsubscribe from this list please visit:
>
>     http://xircles.codehaus.org/manage_email
>

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[JamesPage]

Graeme,

I have just read through it... It is  very readable and useful. So thank you very much for putting in the time for creating it.

Hopefully I will not be using it much because grails is easy to use and understand.

The examples you use are very useful for getting ones head around some new concepts.

All the best

James

On Nov 12, 2007 4:29 PM, Daniel Kimmig <dkimmig@...> wrote:

AWESOME !!!

Exactly what you need for a 1.0 release!


Congratulations on that work!

Graeme Rocher-2 wrote:

>
> Hi All,
>
> I've put up the first draft of the official Grails reference docs.
> Could those of you interested please read through and email back in
> this thread any mistakes or suggestions you find.
>
> http://grails.org/doc/RC1/
>
> Look forward to the feedback.
>
> Cheers
>
> --
> Graeme Rocher
> Grails Project Lead
> G2One, Inc. Chief Technology Officer
> http://www.g2one.com
>
> ---------------------------------------------------------------------
> To unsubscribe from this list please visit:
>
>     http://xircles.codehaus.org/manage_email
>
>
>

--
View this message in context: http://www.nabble.com/First-Draft-Grails-Reference-Docs-tf4790665.html#a13708612
Sent from the grails - user mailing list archive at Nabble.com.

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email

[Jeroen Gordijn]

Super!

Good work.

Graeme Rocher-2 wrote:

Hi All,

I've put up the first draft of the official Grails reference docs.
Could those of you interested please read through and email back in
this thread any mistakes or suggestions you find.

http://grails.org/doc/RC1/

Look forward to the feedback.

Cheers

--
Graeme Rocher
Grails Project Lead
G2One, Inc. Chief Technology Officer
http://www.g2one.com

---------------------------------------------------------------------
To unsubscribe from this list please visit:

    http://xircles.codehaus.org/manage_email