[doc] any volunteers?

classic Classic list List threaded Threaded
5 messages Options
Reply | Threaded
Open this post in threaded view
|

[doc] any volunteers?

robert burrell donkin-2
the organisation's starting to improve a little which should make it
easier to collaborate. i can think of quite a few tasks many of which
are editorial and so don't really require a lot of specialist
knowledge.

any volunteers want to take on some documentation over the next few weeks?

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: [doc] any volunteers?

ant elder-2
Sure ok, I'll volunteer to have a go. What doc do you have in mind?

   ...ant

On 7/30/06, robert burrell donkin <[hidden email]> wrote:

>
> the organisation's starting to improve a little which should make it
> easier to collaborate. i can think of quite a few tasks many of which
> are editorial and so don't really require a lot of specialist
> knowledge.
>
> any volunteers want to take on some documentation over the next few weeks?
>
> - robert
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [hidden email]
> For additional commands, e-mail: [hidden email]
>
>
Reply | Threaded
Open this post in threaded view
|

Re: [doc] any volunteers?

robert burrell donkin-2
On 7/30/06, ant elder <[hidden email]> wrote:
> Sure ok, I'll volunteer to have a go.

great :-)

> What doc do you have in mind?

there are lots of docs which need work so hopefully you'll be able to
find something that interests you :-)

all DRAFTs need work. these are in varying states of completeness.
some of these are just outlines in need of content and shape, some
have a reasonable shape but still need more content, a few just need
some editorial work plus a little content.

i'll go though the various pages we have and what needs doing. the
problem with documentation is that unless the documentation is pretty
close, it can be difficult to merge changes so it's probably best to
avoid working concurrently on the same page. i create a page on the
wiki later but (for now) just indicate which page you'd be interested
in:

http://incubator.apache.org/guides/proposal.html is reasonably close.
there's editorial work needed proof-reading, adding links and add
examples of good practice from existing applications. there are a few
difficult sections needing more content.

http://incubator.apache.org/guides/participation.html is a new-ish
netiquette/getting involve guide. this needs more content and links
into existing documentation but is intended to be a short document.

http://incubator.apache.org/guides/releasemanagement.html is really
just an outline. lot of work required.

http://incubator.apache.org/guides/projects.html is just a landing
page. probably not a good idea to take this one on ATM.

http://incubator.apache.org/guides/entry.html is a landing page with
basic outline. lot of qork required.

http://incubator.apache.org/guides/lists.html needs tidying up. the
index page has a missing link to this page. the website content should
be replaced with a link to the website guide. more content on mailing
list best practices would be good.

alternatively, there are some issues which have recently cropped on
list which could do with being written up for the documentation. this
means some research and gauging the consensus from the list.

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: [doc] any volunteers?

jboynes
On Jul 30, 2006, at 3:15 AM, robert burrell donkin wrote:
>
> http://incubator.apache.org/guides/releasemanagement.html is really
> just an outline. lot of work required.

I had an itch to help with this one.
--
Jeremy

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]

Reply | Threaded
Open this post in threaded view
|

Re: [doc] any volunteers?

robert burrell donkin-2
On 7/30/06, Jeremy Boynes <[hidden email]> wrote:
> On Jul 30, 2006, at 3:15 AM, robert burrell donkin wrote:
> >
> > http://incubator.apache.org/guides/releasemanagement.html is really
> > just an outline. lot of work required.
>
> I had an itch to help with this one.

good

this one has a shape outlined with lots of TODOs. just take a look and
start pickup some of the TODO, create content for the existing
sections or add new ones. it'd work best with short items with plenty
of links. if you don't have incubator karma, please create issues in
JIRA (incubator/site) and i (or someone else) will pick them up. small
patches would probably work well for this document.

i've created a page on the wiki
(http://wiki.apache.org/incubator/DocumentationPlan) to help
coordinate activities. if people edit the page to explain what changes
they're working on then this should stop people treading on each
others toes.

- robert

---------------------------------------------------------------------
To unsubscribe, e-mail: [hidden email]
For additional commands, e-mail: [hidden email]