[prev in list] [next in list] [prev in thread] [next in thread] 

List:       groovy-dev
Subject:    Re: [groovy-dev] Documentation effort update
From:       Andrey Bloschetsov <bloschetsov () gmail ! com>
Date:       2013-07-21 10:52:12
Message-ID: CAPY4TVEnApduoGd7H8nJk1WWPP+1LvUEAC02f9ENQw86v0SQhQ () mail ! gmail ! com
[Download RAW message or body]

Hi all,

2013/7/21 Guillaume Laforge <glaforge@codehaus.org>:
> Glad you're onboard.
> I'm not sure what's the best approach yet.
> It could be in a wiki page for now, as it's easier to edit by anybody.
> We could also go with some JIRA sub-tasks of the JIRA issue about the
> documentation?
> What do you think would be best?

In JIRA we can discuss the emerging questions and problems. For me,
working in Jira more convenient. Also, for better issue management,
you can create a special label in JIRA (for example: new-doc or
ascii-doc).

One question remains: who will control the creation of tasks and
sub-tasks? I see the following options:
1. The guys from Groovy team create tasks and the contributors just
write about their intentions in the comments.
2. The contributors themselves create tasks and specify a doc label.
3. ...

>
> Guillaume
>
>
> On Sat, Jul 20, 2013 at 10:00 AM, Andrey Bloschetsov <bloschetsov@gmail.c=
om>
> wrote:
>>
>> Or it might be a asciidoc page in the documentation branch.
>>
>> 2013/7/20 Andrey Bloschetsov <bloschetsov@gmail.com>:
>> > Hi all, I am on board!
>> >
>> > Perhaps, it would be nice to have a single wiki page with the simple
>> > table: page title, url, status (empty, in progress [part of page -
>> > person], done). What do you think?
>> >
>> > 2013/7/19 C=C3=A9dric Champeau <cedric.champeau@gmail.com>:
>> >> Le 19/07/2013 16:48, Matthew Adams a =C3=A9crit :
>> >>
>> >> On Fri, Jul 19, 2013 at 6:30 AM, C=C3=A9dric Champeau
>> >> <cedric.champeau@gmail.com>
>> >> wrote:
>> >>>
>> >>> The  documentation is in the form of Asciidoc documents (and uses th=
e
>> >>> Asciidoctor library), and can be found in the core project and all
>> >>> subprojects under src/doc/spec.
>> >>> Associated  tests which are actual running test cases are included i=
n
>> >>> the
>> >>> Asciidoc  documents with an include directive, and are situated in
>> >>> src/doc/test.
>> >>
>> >>
>> >> I noticed it's actually src/spec/doc & src/spec/test...
>> >>
>> >> Good catch!
>> >>
>> >>
>> >> --
>> >> C=C3=A9dric Champeau
>> >> SpringSource - Pivotal
>> >> http://www.springsource.org/
>> >> http://www.gopivotal.com/
>> >> http://twitter.com/CedricChampeau
>> >
>> >
>> >
>> > --
>> > Andrey Bloschetsov
>>
>>
>>
>> --
>> Andrey Bloschetsov
>>
>> ---------------------------------------------------------------------
>> To unsubscribe from this list, please visit:
>>
>>     http://xircles.codehaus.org/manage_email
>>
>>
>
>
>
> --
> Guillaume Laforge
> Groovy Project Manager
> Head of Groovy Development at SpringSource
> http://www.springsource.com/g2one



--
Andrey Bloschetsov

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

    http://xircles.codehaus.org/manage_email


[prev in list] [next in list] [prev in thread] [next in thread]