On Thu, Apr 04, 2013 at 10:59:34AM -0400, Sebastien Goasguen wrote:
> 
> On Apr 4, 2013, at 10:53 AM, Radhika Puthiyetath 
> <radhika.puthiyet...@citrix.com> wrote:
> 
> > My two cents
> > 
> > We should go to conferences specifically meant for writers, and market 
> > CloudStack. That way, we could attract good freelancers.
> > 
> > The other way is to reach out to students and offer internship to those who 
> > are interested in writing. ..In the due course, both parties are mutually 
> > benefited: Students get good industry exposure on cutting edge technology, 
> > whereas we might get good writers to work on CloudStack docs..
> > 
> > -Radhika
> > 
> > -----Original Message-----
> > From: Chip Childers [mailto:chip.child...@sungard.com] 
> > Sent: Thursday, April 04, 2013 7:37 PM
> > To: dev@cloudstack.apache.org
> > Subject: Re: [DOCS] More OSS writers needed
> > 
> > On Wed, Apr 03, 2013 at 07:31:19PM -0700, Jessica Tomechak wrote:
> >> In this morning's IRC chat, it was very properly pointed out that 
> >> CloudStack could use more doc writers.
> >> 
> >> We have a backlog of suggestions for large, new documentation 
> >> projects. We collected these suggestions under the Doc Writers wiki 
> >> page. I have just opened Jira tickets for each of the items, to make 
> >> them more visible and easier to grab for whatever new OSS writers are 
> >> interested!
> >> 
> >> Please feel free to add more items, or vote up/down on any of the 
> >> suggested new documents, or assign a ticket to yourself and write.
> >> 
> >> https://cwiki.apache.org/confluence/display/CLOUDSTACK/Documentation+S
> >> uggestion+Box
> >> 
> >> Cheers,
> >> Jessica T.
> > 
> > This is great...  but do you (others) have any ideas about how we can 
> > attract new tech writers to the project?  I think that we obviously have
> > *lots* of work to do, which frankly can even go into helping to curate the 
> > wiki, etc...  My personal concern is getting enough volunteers to work on 
> > all of this!
> 
> If I were a dictator I would force every new feature to land in the source 
> code *with* documentation. No documentation, no commit.
> Of course folks would hate me for it :) and the project might die. However I 
> read that Django tries to do this.

We discussed this in the March 20 IRC meeting [1] (see the "# 4. Active Feature
Release: Docs Status #" section).  If someone wants to propose this as a
feature merge requirement, I'd +1 it.  As long as we're not being too
onerous about it, even simple descriptions help.

To me, the value of concerted docs efforts shouldn't be to discover some
new feature without the developer describing it first.  The goal should
be to refine, edit, elaborate and ensure consistent style.

[1] http://markmail.org/thread/5yz54injegmxdxgj

> 
> CloudStack is a complex software and the best people to write the docs are 
> really the folks who write the features. 
> In addition, lots of features require advanced setup that a lot of tech 
> writers won't have at their disposal.
> 
> Maybe couple days before the next CloudStack conference we can have a face to 
> face WriteaThon...
> 

Great idea!

> -Sebastien
> 
> 
> 

Reply via email to