How's our documentation looking?

Clint Byrum clint at ubuntu.com
Wed Mar 14 07:07:44 UTC 2012


Excerpts from Kapil Thangavelu's message of Tue Mar 13 23:18:33 -0700 2012:
> Excerpts from Robbie Williamson's message of 2012-03-13 14:36:28 -0700:
> > I was reading through a thread on the openstack list about the state of
> > their documentation and it made me think that with all the recent
> > changes we have had this cycle, are we up-to-date on our docs?
> > 
> > A quick look through what we have now is showing a lot of
> > inconsistencies and missing documented features.  Is feature
> > documentation a part of the code review/approve process?  If not, should
> > it be?  Juju is kickass, but adoption will suffer a lot if our
> > documentation can't educate new users on how to use it.
> > 
> > Any thoughts on how we can get this sorted for the bits we ship in
> > 12.04?  Maybe a documentation day(s) after Beta 2 (March 29th)?
> 
> 
> The documentation is getting bit-rotted outside of new specs of features being 
> implemented. I had hoped we'd get more community contributions by splitting the 
> docs out the of the codebase, but that hasn't happened. At this point i'm hoping 
> to take have the team work on the docs at the end of the cycle b4 the final 
> release. Some documentation cleanup days before then do sound good.

"Then" is now if you're talking about the end of the release cycle. We
have less than a month before the final beta is released (3/29)[1]. The
official documentation freeze is actually 3/22, though we won't be
subject to that since we're talking about online docs.

I've never understood how splitting the docs into another branch would
attract more contribution. If anything its now more confusing because
trunk still has docs and its not clear where to edit docs... we should
perhaps make it a priority to clear out the docs directory from lp:juju.

I don't recall, did we ever put out a call for help after the split? There
may be people out there who don't know that we need help but would be
thrilled to at least review the docs.

--

1. https://wiki.ubuntu.com/PrecisePangolin/ReleaseSchedule



More information about the Juju mailing list