« Return to Thread: First Draft Grails Reference Docs
Re: First Draft Grails Reference Docs
by Graeme Rocher-2
::
Rate this Message:
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
> 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
« Return to Thread: First Draft Grails Reference Docs
| Free embeddable forum powered by Nabble | Forum Help |
